Attach Campaign | Pinnacle

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.phoneNumbers.campaign.attach({
        phones: [
            "+14155550123",
            "+14155559876",
            "+14155550111",
        ],
        campaignType: "TOLL_FREE",
        campaignId: "tf_1234567890",
    });
}
main();

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

Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

phoneslist of stringsRequired

List of phone number (E.164 format).

Limit: 1 to 10

campaignTypeenumRequired

Type of messaging profile associated with the phone number.

Allowed values:

campaignIdstringRequired

Unique identifier for the campaign.

TOLL_FREE campaigns:
- Must begin with the prefix tf_
- Example: tf_1234567890
10DLC campaigns:
- Must begin with the prefix dlc_
- Example: dlc_1234567890

Response

Successfully attached the campaign.

phoneNumberslist of objects

List of phone numbers.

failedlist of objects

List of numbers that were not failed to be attached.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

501

Not Implemented Error