Audience

Audiences (lists)

Group contacts into the audiences you send campaigns to.

An audience (list) is a named group of contacts. Campaigns and sequences target audiences.

GET/v1/listsList your audiences.

POST/v1/listsCreate an audience.

GET/v1/lists/:idFetch one audience.

PATCH/v1/lists/:idRename or edit an audience.

DELETE/v1/lists/:idDelete an audience.

GET/v1/lists/:id/contactsList the contacts in an audience.

POST/v1/lists/:id/contactsAdd contacts to an audience.

DELETE/v1/lists/:id/contacts/:contactIdRemove a contact from an audience.

audience.ts

const list = await mail.lists.create({ name: "Newsletter" });
await mail.lists.addContacts(list.id, ["ada@example.com", "grace@example.com"]);