Detach Campaign | Pinnacle

Remove the association between a phone number and its attached campaign.

PINNACLE-API-KEYstring

API Key authentication via header

This endpoint expects an object.

phoneslist of stringsRequired

List of phone numbers (E.164 format).

Limit: 1 to 10

Successfully detached the campaign.

phoneNumberslist of objects

List of phone numbers.

failedlist of objects

List of numbers that were not failed to be detached.

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

501

Not Implemented Error

1	import { PinnacleClient } from "rcs-js";
2
3	const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
4	await client.phoneNumbers.campaign.detach({
5	phones: ["+14155559876", "14155550111"]
6	});

1	{
2	"phoneNumbers": [
3	{
4	"phoneNumber": "+14155559876",
5	"campaign": {
6	"id": "dlc_1234567890",
7	"name": "Summer Promo",
8	"type": "10DLC"
9	}
10	}
11	],
12	"failed": [
13	{
14	"number": "+14155550111",
15	"error": "Number is not available. Make sure your team owns this number and it is not a sandbox number."
16	}
17	]
18	}