API ReferenceCampaignsToll-Free

Submit Toll-Free Campaign

Submit your toll-free campaign for approval and activation with carriers.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

campaignIdstringRequired

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

Response

Successfully submitted toll-free campaign for approval.

successboolean
Indicates whether the campaign submission was successful.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error