campaigns > tollFree

Get Toll-Free Campaign by ID

Retrieve Toll-Free campaign.

get/campaigns/toll-free/{campaignId}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/campaigns/toll-free/{campaignId}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

campaignIdstring required

Unique identifier of toll-free campaign. Must begin with the prefix tf_.

Response

Successfully retrieved.

status'INCOMPLETE' | 'IN REVIEW' | 'VERIFIED' | 'FAILED' required

Current review status of the campaign. <br>

INCOMPLETE: Not submitted. <br>

IN REVIEW: Being reviewed by carriers. <br>

VERIFIED: Approved and ready to send messages.<br>

FAILED: Issues and errors related to the campaign's details.

campaignIdstring required

Unique identifier for the campaign. Begins with the prefix tf_.

monthlyVolume'10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+'

Message volume.

namestring

Display name of the campaign.

productionMessageContentstring

Explain message that would be sent.

Changes

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