Detach Campaign API Reference

Serverhttps://api.pinnacle.sh/

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

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

phonesarray<string>

List of phone numbers (E.164 format).

Limit: 1 to 10

Items

1 <= items <= 10

Each item

Example

"+14155550142"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

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

await client.phoneNumbers.campaign.detach({
    phones: ["+14155559876", "14155550111"]
});

Responses

{  "phoneNumbers": [    {      "phoneNumber": "+14155559876",      "campaign": {        "id": "dlc_1234567890",        "name": "Summer Promo",        "type": "10DLC"      }    }  ],  "failed": [    {      "number": "+14155550111",      "error": "Number is not available. Make sure your team owns this number and it is not a sandbox number."    }  ]}

Detach Campaign

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Detach Campaign

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

501application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`