API ReferenceCampaignsToll-Free

Get Toll-Free Campaign by ID

Retrieve Toll-Free campaign.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

campaignIdstringRequired

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

Response

Successfully retrieved.
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