API ReferenceAudiences

Add Contacts to Audience

Add contacts to an existing audience. This operation is additive and idempotent. - Phone numbers that don't exist will be auto-created as contacts - Duplicate adds are ignored - Contacts already in the audience are ignored

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

Request payload for adding contacts to an audience.
idstringRequiredformat: "^aud_"

Audience ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.

contactslist of stringsRequired

Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).

Response

Successfully added contacts to the audience.
idstring

Audience public ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.

namestring
Audience name.
descriptionstring
Audience description.
contactCountinteger

Total number of contacts in audience.

Use the Get Audience endpoint with the pagination parameters to get the audience with its contacts.

Errors