phoneNumbers > campaign

Attach Campaign

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

post/phone-numbers/attach-campaign

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/phone-numbers/attach-campaign
  • Auth: API key in header PINNACLE-API-KEY

Request body

phonesstring[] required

List of phone number (E.164 format). <br><br> Limit: 1 to 10

campaignType'TOLL_FREE' | '10DLC' required

Type of messaging profile associated with the phone number.

campaignIdstring required

Unique identifier for the campaign. <br>

  • 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.

Changes

No recorded changes to this operation across all 1 revision of this API.