campaigns > dlc

Autofill 10DLC Campaign Information

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

post/campaigns/dlc/autofill

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/campaigns/dlc/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 10DLC information.

autoRenewboolean required

Whether the campaign renews automatically.

brandstring

Brand id. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

campaignIdstring

Unique identifier for the campaign. This identifier is a string that always begins with the prefix dlc_, for example: dlc_1234567890.

descriptionstring

Description of the campaign.

messageFlowstring

Describe the flow of how users will opt in to this campaign. See the Opt-In Methods and Workflow section for requirements.

namestring

Display name of the campaign.

sampleMessagesstring[]

Example messages for the campaign. See the Sample Messages section for requirements.

Changes

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