API ReferenceCampaignsToll-Free

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](/api-reference/brands/upsert) first — you'll need its `id` for the [`brand`](#request.body.brand) field. All fields are **required** unless specified otherwise, and will be validated when [submitted](/api-reference/campaigns/toll-free/submit). **See the response for example values for each field.** </Note>

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
brandstringOptional

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

campaignIdstringOptional

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

keywordsobjectOptional
Keyword response configuration.
monthlyVolumeenumOptional
Message volume.
namestringOptional
Display name of the campaign. This is not sent to carriers for approval and is only used for your reference on the Pinnacle dashboard.
optInobjectOptional

Opt-in method and workflow.

optionsobjectOptional
Campaign configuration options.
productionMessageContentstringOptional<=1000 characters

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.

useCaseobjectOptional
Use case classification for the campaign.

Response

Successfully created or updated toll-free campaign.

brandobject
Brand associated with this campaign.
statusenum

Current review status of the brand.

INCOMPLETE: Has not been submitted.
PENDING: Currently being reviewed.
VERIFIED: Verified and good to go.
VETTED: Brand has been vetted by an external provider and has received vetting scores.

Allowed values:
campaignIdstring

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

keywordsobject or null
Keyword response configuration.
monthlyVolumeenum or null
Message volume.
namestring or null
Display name of the campaign.
optInobject or null

Opt-in keyword settings.

optionsobject or null
Campaign configuration options.
productionMessageContentstring or null
Explain message that would be sent.
useCaseobject or null
Use case classification for the campaign.

Errors