API ReferenceCampaigns10DLC

Get 10DLC Campaign by ID

Retrieve 10DLC campaign.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

campaignIdstringRequired

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

Response

Successfully retrieved.
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