API ReferenceCampaignsToll-Free

Upsert Toll-Free Campaign

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

Omit campaignId to create a campaign.

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.

monthlyVolumeenumOptional
Message volume.
namestringOptional
Display name of the campaign.
optInobjectOptional

Opt-in keyword settings.

productionMessageContentstringOptional<=1000 characters
Explain message that would be sent.
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 or null

Unique identifier for the campaign. Must begin with the prefix tf_.

monthlyVolumeenum or null
Message volume.
namestring or null
Display name of the campaign.
optInobject or null

Opt-in keyword settings.

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

Errors