campaigns > tollFree

Create or Update Toll-Free Campaign

Create a new toll-free campaign or update an existing one.

<Note> **To create a new campaign:** Omit `campaignId` — one will be generated automatically.

Before you start: Create a brand first — you'll need its id for the brand field.

All fields are required unless specified otherwise, and will be validated when submitted.

See the response for example values for each field. </Note>

post/campaigns/toll-free

Request

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

Request body

brandstring

Brand id. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

campaignIdstring

Unique identifier for the campaign. This identifier is a string that always begins with the prefix tf_, for example: tf_1234567890.

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. This is not sent to carriers for approval and is only used for your reference on the Pinnacle dashboard.

productionMessageContentstring

Example message(s) that would be sent in production. Should reflect the actual content users will receive, including HELP/STOP disclosures. See the Production Message Content section for requirements.

Response

Successfully created or updated toll-free campaign.

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.