API ReferenceAudiences

Update Audience

Update audience metadata. This endpoint does NOT modify contacts.

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

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

Request payload for updating audience metadata.
idstringRequiredformat: "^aud_"

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

namestringOptional>=1 character
New audience name.
descriptionstringOptional
New audience description.

Response

Successfully updated the audience.
idstring

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

namestring
Audience name.
descriptionstring
Audience description.
contactCountinteger

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