Create 10DLC campaign
msg_create_campaignRegister a new 10DLC campaign under your brand for A2P messaging. Submit sample messages, consent flow, and opt-in rules for carrier review and approval.
Instructions
Register a new 10DLC campaign under one of your brands. This is STEP 2 of the 10DLC flow: msg_create_brand → create campaign → msg_assign_numbers. Check msg_get_use_case_requirements for the chosen use case first (sample counts, opt-in rules). Carrier review can take days; monitor with msg_get_mno_status. Registration incurs recurring TCR fees. Errors: INVALID_PAYLOAD/TNIQ_VALIDATION (400), TNIQ_ERROR (502).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sample1 | No | Sample message 1 (representative outbound text) | |
| sample2 | No | Sample message 2 | |
| sample3 | No | Sample message 3 | |
| sample4 | No | Sample message 4 | |
| sample5 | No | Sample message 5 | |
| usecase | No | Campaign use case code, e.g. MARKETING, 2FA, CUSTOMER_CARE (see msg_list_use_cases; check msg_get_use_case_requirements first) | |
| brand_id | No | Parent brand ID (messaging-backend UUID from msg_list_brands). Required when creating a campaign. | |
| age_gated | No | True if content is age-gated (alcohol, gambling, etc.) | |
| description | No | What this campaign sends and to whom (reviewed by carriers) | |
| number_pool | No | True if the campaign uses 50+ sending numbers (number pooling) | |
| auto_renewal | No | Auto-renew the campaign at TCR each billing cycle | |
| help_message | No | Reply sent when a subscriber texts a help keyword | |
| message_flow | No | How subscribers opt in to receive messages (consent flow description; heavily weighted in carrier review) | |
| reference_id | No | Your own free-form reference ID for this campaign | |
| sub_usecases | No | Sub-use-case codes for MIXED/LOW_VOLUME campaigns | |
| embedded_link | No | True if messages may contain URLs/links | |
| help_keywords | No | Comma-separated help keywords, e.g. "HELP,INFO" | |
| optin_message | No | Confirmation message sent after a subscriber opts in | |
| direct_lending | No | True if content relates to direct lending or loan arrangements | |
| embedded_phone | No | True if messages may contain phone numbers | |
| optin_keywords | No | Comma-separated opt-in keywords, e.g. "START,SUBSCRIBE" | |
| optout_message | No | Confirmation message sent after a subscriber opts out | |
| optout_keywords | No | Comma-separated opt-out keywords, e.g. "STOP,UNSUBSCRIBE" | |
| subscriber_help | No | True if subscribers can request help via keyword (HELP handling) | |
| subscriber_optin | No | True if subscribers can opt in via keyword | |
| subscriber_optout | No | True if subscribers can opt out via keyword (STOP handling) | |
| terms_and_conditions | No | Affirm the campaign complies with carrier terms and conditions |