API ReferenceCampaigns10DLC

Autofill 10DLC Campaign Information

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

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
additionalInfostringOptional
Any additional information you want to provide.
campaignIdstringOptional
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.
autoRenewbooleanDefaults to true
Whether the campaign renews automatically.
brandstring or null

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

campaignIdstring or null

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

descriptionstring or null
Description of the campaign.
keywordsobject or null
Keyword response configuration.
messageFlowstring or null
Describe the flow of how users will opt in to this campaign.
namestring or null
Display name of the campaign.
optionsobject or null
Campaign configuration options.
sampleMessageslist of strings or null
Example messages for the campaign.
useCaseobject or null
Use case for the campaign.

Errors