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.
id
Audience ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.
contacts
Array of phone numbers (E.164 format) or contact IDs.
Limit: 1 min
Response
Successfully added contacts to the audience.
id
Audience public ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.
name
Audience name.
description
Audience description.
contactCount
Total number of contacts in audience.
Use the Get Audience endpoint with the pagination parameters to get the audience with its contacts.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
