Delete Audience API Reference

Serverhttps://api.pinnacle.sh/

Permanently delete an audience and all its contact associations.

Note: This will NOT delete the contacts themselves, only the audience and its memberships.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Query Parameters

idstring

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

Match

^aud_

Example

"aud_01J8K3R7M9"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.audiences.delete({
    id: "aud_abc123"
});

Responses

{  "success": true}

Delete Audience

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`