Pinnacle
API ReferenceAudiences

Add Contacts to Audience

Serverhttps://api.pinnacle.sh/
PATCH
/audiences/contacts

Request body

Edit JSON, then apply it to your request.

JSON

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

Authorization

Pinnacle API key
PINNACLE-API-KEY<token>

In: header

Request Body

application/json

Request payload for adding contacts to an audience.

TypeScript Definitions

Use the request body type in TypeScript.

idstring

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

Match
^aud_
Example
"aud_01J8K3R7M9"
contactsarray<string>

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

Limit: 1 min

Items
1 <= items
Each item
Example
"+14155550142"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Audiences

Create reusable recipient groups and manage audience membership.

Create AudiencePOST

Create a new audience with optional initial contacts. Phone numbers that don't exist will be auto-created as contacts.

Pinnacle referenceAsk Pinnacle

Get a sourced answer from the published documentation.

ViewingPinnacle documentation

Conversations are saved for analysis.

Try asking