SUsurgeapi
Toll-Free Campaigns

Retrieve a toll-free campaign

Changed on

Retrieves a toll-free campaign object.

get/toll_free_campaigns/{campaign_id}

Request

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

Path parameters

campaign_idstring required

The ID of the toll-free campaign to retrieve.

Example:tfc_01j9a43avnfqzbjfch6pygv1td

Response

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