Attach Campaign

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.phoneNumbers.campaign.attach({}); 8 } 9 main();

1 { 2 "phoneNumbers": [ 3 { 4 "phoneNumber": "+14155550123", 5 "campaign": { 6 "id": 101, 7 "name": "Summer Promo", 8 "type": "TOLL_FREE" 9 } 10 }, 11 { 12 "phoneNumber": "+14155559876", 13 "campaign": { 14 "id": 102, 15 "name": "Winter Blast", 16 "type": "TOLL_FREE" 17 } 18 } 19 ], 20 "failed": [ 21 { 22 "number": "+14155550111", 23 "error": "Number is not available. Make sure your team owns this number and it is not a sandbox number." 24 } 25 ] 26 }

Link a phone number to a specific campaign.

Request

This endpoint expects an object.

phoneslist of stringsRequired

List of phone number (E.164 format).

campaignTypeenumRequired

Type of messaging profile associated with the phone number.

Allowed values:

campaignIdintegerRequired>=1

Campaign's identifier.

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.

Headers

Request

Response

Errors