Create Audience | Pinnacle

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

PINNACLE-API-KEYstring

API Key authentication via header

Request payload for creating a new audience.

namestringRequired>=1 character

Audience name.

descriptionstringOptional

Audience description.

contactslist of stringsOptional

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

Successfully created 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.create({});
8	}
9	main();

1	{
2	"id": "aud_abc123",
3	"name": "Marketing Campaign Q1",
4	"description": "Contacts for Q1 marketing push",
5	"contactCount": 2
6	}