Audiences > contacts

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
patch/audiences/contacts

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/audiences/contacts
  • Auth: API key in header PINNACLE-API-KEY

Request body

idstring required

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

contactsstring[] required

Array of phone numbers (E.164 format) or contact IDs. <br><br> Limit: 1 min

Response

Successfully added contacts to the audience.

idstring required

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

namestring required

Audience name.

descriptionstring required

Audience description.

contactCountinteger required

Total number of contacts in audience.

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

Changes

No recorded changes to this operation across all 1 revision of this API.