Toll-Free Campaigns

Create a toll-free campaign

Changed on

Creates a toll-free campaign and submits it for Surge review.

post/accounts/{account_id}/toll_free_campaigns

Request

  • Base URL
    https://api.surge.app
  • URL
    https://api.surge.app/accounts/{account_id}/toll_free_campaigns
  • Auth
    HTTP bearer

Path parameters

account_idstring required

The account for which the toll-free campaign should be created.

Example:acct_01j9a43avnfqzbjfch6pygv1td

Request body

descriptionstring required

An explanation of how the toll-free number will be used.

includesstring[]
message_samplesstring[] required
phone_number_idstring required

The toll-free phone number to register.

privacy_policy_urlstring uri required
terms_and_conditions_urlstring uri required
use_casesstring[] required

Response

Created toll-free campaign

descriptionstring nullable required
idstring required

The toll-free campaign ID

includesstring[] required
message_samplesstring[] required
phone_number_idstring required

The toll-free phone number ID

privacy_policy_urlstring uri nullable required
status'active' | 'canceled' | 'created' | 'in_review' | 'rejected' required

The current status of the toll-free campaign.

terms_and_conditions_urlstring uri nullable required
use_casesstring[] required

Changes