API ReferenceCampaigns10DLC

Upsert 10DLC Campaign

Create a new 10DLC campaign or updates an existing one.

Omit campaignId to create a campaign.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
autoRenewbooleanOptionalDefaults to true
Whether the campaign renews automatically.
brandstringOptional

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

campaignIdstringOptional

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

descriptionstringOptional40-4096 characters
Description of the campaign.
keywordsobjectOptional
Keyword response configuration.
messageFlowstringOptional40-4096 characters
Describe the flow of how users will opt in to this campaign.
namestringOptional
Display name of the campaign.
optionsobjectOptional
Campaign configuration options.
sampleMessageslist of stringsOptional
Example messages for the campaign.
useCaseobjectOptional
Use case for the campaign.

Response

Successfully created or updated DLC campaign.
autoRenewboolean
Whether the campaign renews automatically.
brandobject
Brand associated with this campaign.
keywordsobject
Keyword response configuration.
optionsobject
Campaign configuration options.
statusenum

Current review status of the campaign.

INCOMPLETE: Not submitted.

IN REVIEW: Being reviewed by carriers.

VERIFIED: Approved and ready to send messages.

FAILED: Issues and errors related to the campaign’s details.

Allowed values:
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.
messageFlowstring or null
Describe the flow of how users will opt in to this campaign.
namestring or null
Display name of the campaign.
sampleMessageslist of strings or null
Example messages for the campaign.
useCaseobject or null
Use case for the campaign.

Errors