Update Audience | Pinnacle

Update audience metadata. This endpoint does NOT modify contacts.

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

PINNACLE-API-KEYstring

API Key authentication via header

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.

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.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.audiences.update({
8	id: "aud_abc123",
9	name: "Updated Audience Name",
10	description: "New description",
11	});
12	}
13	main();

1	{
2	"id": "aud_abc123",
3	"name": "Updated Audience Name",
4	"description": "New description",
5	"contactCount": 150
6	}