campaigns > tollFree

Autofill Toll-Free Campaign Information

Generate campaign details based off existing campaign and the brand it's connected to.

post/campaigns/toll-free/autofill

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/campaigns/toll-free/autofill
  • Auth: API key in header PINNACLE-API-KEY

Request body

additionalInfostring

Any additional information you want to provide.

campaignIdstring

Unique identifier for the campaign.

  • When autofilling 10DLC campaigns, it must begin with the prefix dlc_ (e.g., dlc_1234567890)
  • When autofilling Toll-Free campaigns, it must begin with the prefix tf_ (e.g., tf_1234567890)
  • When autofilling RCS campaigns, it must begin with the prefix rcs_ (e.g., rcs_1234567890)

Response

Returns autofilled toll-free information.

brandstring
campaignIdstring

Unique identifier for the campaign. Must begin with the prefix tf_.

monthlyVolume'10' | '100' | '1,000' | '10,000' | '100,000' | '250,000' | '500,000' | '750,000' | '1,000,000' | '5,000,000' | '10,000,000+'

Message volume.

namestring

Display name of the campaign. This is not sent to carriers for approval and is only used for your reference on the Pinnacle dashboard.

productionMessageContentstring

Example message(s) that would be sent in production. Should reflect the actual content users will receive. See the Production Message Content section for requirements.

Changes

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