status > get

Get Toll-Free Campaign Status

Retrieve a toll-free campaign's status.

get/status/toll-free-campaign/{campaignId}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/status/toll-free-campaign/{campaignId}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

campaignIdstring required

The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix tf_, for example: tf_1234567890.

Response

Successfully retrieved.

errorstring

Summary of errors related to the verification process. <br>

These errors may request additional information or point out erroneous and/or missing fields.

idstring required

The unique identifier of the toll-free campaign. This identifier is a string that always begins with the prefix tf_, for example: tf_1234567890.

Changes

No recorded changes to this operation across all 1 revision of this API.