Audiences

Create Audience

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

post/audiences

Request

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

Request body

namestring required

Audience name.

descriptionstring

Audience description.

contactsstring[]

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

Response

Successfully created 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.