Register a campaign

​

Registers a campaign for your brand: what you send, how recipients consent, and how HELP and STOP behave. Registration charges the registry's upfront, non-refundable three-month fee, so the request must repeat the quarterly_fee from the use-case listing as confirmed_upfront_fee. If the live fee no longer matches, nothing is charged and the answer is 409. Idempotency-Key is required and makes any retry safe: the same key returns the original registration (recovering it even when the first response was lost) and never charges twice; reusing the key with changed content returns 409. Registry and carrier review then run for hours to days — follow progress with GET /v1/10dlc/campaigns/{campaign_id}. A per-organization ceiling bounds new campaign submissions per day; the deployment default is ten.

Headers

  • Idempotency-Key
    Type: string
    min length:  
    1
    max length:  
    255
    required

    Repeat this value to retry safely: the same key returns the original registration instead of charging again.

Body·

required
application/json
  • confirmed_upfront_fee
    Type: string
    required

    The non-refundable three-month amount shown in the qualification listing. Submission is refused if the live fee no longer matches.

  • description
    Type: string
    min length:  
    40
    max length:  
    4096
    required

    What this campaign's messages are about, for registry reviewers.

  • help_message
    Type: string
    min length:  
    20
    max length:  
    320
    required

    The reply a recipient gets after texting a help keyword.

  • message_flow
    Type: string
    min length:  
    40
    max length:  
    2048
    required

    How a recipient consents to these messages, step by step.

  • optout_message
    Type: string
    min length:  
    20
    max length:  
    320
    required

    The final reply a recipient gets after opting out.

  • Type: string
    max length:  
    255
    required

    Public privacy-policy URL.

  • sample_messages
    Type: array of string 1…5
    min length:  
    1
    max length:  
    1024
    required

    One to five representative message texts.

  • Type: string
    max length:  
    255
    required

    Public terms-and-conditions URL.

  • usecase
    Type: enum
    required

    The use case to register, from the qualification listing.

    values
    • 2FA
    • ACCOUNT_NOTIFICATION
    • AGENTS_FRANCHISES
    • CHARITY
    • CUSTOMER_CARE
    • DELIVERY_NOTIFICATION
    • EMERGENCY
    • FRAUD_ALERT
  • age_gated
    Type: boolean

    Whether the content is age-restricted.

  • direct_lending
    Type: boolean

    Whether messages relate to direct lending or loan arrangements.

  • Type: boolean

    Whether messages contain web links.

Responses

  • application/json
  • application/json
Request Example for post/v1/10dlc/campaigns
curl /v1/10dlc/campaigns \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "usecase": "LOW_VOLUME",
  "description": "",
  "sample_messages": [
    ""
  ],
  "message_flow": "",
  "help_keywords": "HELP",
  "help_message": "",
  "optin_keywords": "",
  "optin_message": "",
  "optout_keywords": "STOP",
  "optout_message": "",
  "privacy_policy_link": "",
  "terms_and_conditions_link": "",
  "age_gated": false,
  "direct_lending": false,
  "embedded_link": false,
  "embedded_phone": false,
  "subscriber_optin": true,
  "subscriber_optout": true,
  "subscriber_help": true,
  "sub_usecases": [
    "ACCOUNT_NOTIFICATION"
  ],
  "confirmed_upfront_fee": "6.00"
}'

{
  "campaign_id": "6d40039b-0fc1-c114-c8e2-8a5294fd9941",
  "status": "registered"
}

Successful Response