campaigns > dlc

Create or Update 10DLC Campaign

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

<Note> **To create a new campaign:** Omit `campaignId` — one will be generated automatically.

Before you start: Create a brand first — you'll need its id for the brand field.

All fields are required unless specified otherwise, and will be validated when submitted.

See the response for example values for each field. </Note>

post/campaigns/dlc

Request

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

Request body

autoRenewboolean

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. Explain the purpose, use case, and types of messages your campaign will send.

Example: This campaign allows users who have specifically opted in to interact with our chatbot for a range of automated services, including order status notifications, shipping updates, security alerts, and help desk support. Users can manage their account, receive transactional SMS prompts, and access interactive support. They may also share images, such as receipts, and receive immediate responses for support or account updates. All messages are strictly transactional or support-related, never unsolicited, and initiated only after clear user consent.

messageFlowstring

Describe your opt-in workflow. See the Opt-In Methods and Workflow section for requirements and examples.

namestring

Display name of the campaign.

sampleMessagesstring[]

Example messages for the campaign. Include 1-5 messages that represent the types of messages you will send. See the Sample Messages section for requirements and examples.

Response

Successfully created or updated DLC campaign.

autoRenewboolean required

Whether the campaign renews automatically.

campaignIdstring required

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.

status'INCOMPLETE' | 'IN REVIEW' | 'VERIFIED' | 'FAILED' required

Current review status of the campaign. <br>

INCOMPLETE: Not submitted. <br>

IN REVIEW: Being reviewed by carriers. <br>

VERIFIED: Approved and ready to send messages.<br>

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

mnoBrandTier'TOP' | 'HIGH_MID' | 'LOW_MID' | 'LOW'

The MNO brand tier for T-Mobile rate limits. Tiers range from TOP (highest) to LOW (lowest), based on your brand's vetting score.

See SMS Rate Limits for details.

mnoTcrTier'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'N' | 'T' | 'S'

The MNO TCR message class for AT&T, Verizon, and other carriers. Classes A-G are standard (based on vetting score), while T, N, and S are for special use cases.

See SMS Rate Limits for details.

Changes

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