Pinnacle
API ReferenceCampaignsToll-Free Campaigns

Validate Toll-Free Campaign Information

Serverhttps://api.pinnacle.sh/
POST
/campaigns/toll-free/validate

Request body

Edit JSON, then apply it to your request.

JSON

Validate your toll-free campaign configuration against carrier requirements and compliance rules.

Authorization

Pinnacle API key
PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

additionalInfostringOptional

Any additional information you want to provide.

Example
"We send appointment reminders and account updates."
campaignIdstring

Unique identifier for the campaign.

  • When validating 10DLC campaigns, it must begin with the prefix dlc_ (e.g., dlc_1234567890)
  • When validating toll-free campaigns, it must begin with the prefix tf_ (e.g., tf_1234567890)
  • When validating RCS campaigns, it must begin with the prefix rcs_ (e.g., rcs_1234567890)
Example
"campaign_01J8K3R7M9"

Response Body

application/json

application/json

application/json

application/json

application/json

Create or Update Toll-Free CampaignPOST

Create a new toll-free campaign or update an existing one. To create a new campaign: Omit campaignId — one will be generated automatically. Before you start: Create a…

Create ConferencePOST

Create a conference: a room that calls can be added to. Each participant is an ordinary call. You can add participants in the same request. Existing calls are added…

Pinnacle referenceAsk Pinnacle

Get a sourced answer from the published documentation.

ViewingPinnacle documentation

Conversations are saved for analysis.

Try asking