Audiences

Update Audience

Update audience metadata. This endpoint does NOT modify contacts.

To add or remove contacts, use the Add Contacts or Remove Contacts endpoints.

patch/audiences

Request

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

Request body

idstring required

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

namestring

New audience name.

descriptionstring

New audience description.

Response

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