FlaresendDocs
Audiences

Add contacts to an audience

Put up to 5,000 existing contacts into an audience.

POST/v1/audiences/{id}/contactsAPI key

Adds contacts by ID. The contacts must already exist in the project; create them first with Create a contact or Import contacts.

Contacts already in the audience are skipped, and duplicate IDs in the request count once. If any ID is not a contact in this project, the request fails with 404 and nothing is added.

Path parameters

idstringpathrequired

The audience ID.

Body parameters

contactIdsstring[]required

1 to 5,000 contact IDs.

Response

addednumber

How many contacts were newly added. Contacts that were already in the audience are not counted.

Errors

StatusCodeWhen
400invalid_bodycontactIds is missing, empty or has more than 5,000 entries.
404audience_not_foundNo audience with that ID in this project.
404contact_not_foundOne of the IDs is not a contact in this project. The message names the first one.