Submit Campaign
Before creating a campaign, use the Qualify By Usecase endpoint to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign. Please note: After campaign creation, you'll only be able to edit the campaign's sample messages. Creating a campaign will entail an upfront, non-refundable three month's cost that will depend on the campaign's use case (see 10DLC Costs section for details).
Request body
Age gated message content in campaign.
Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle.
Alphanumeric identifier of the brand associated with this campaign.
Summary description of this campaign.
Direct lending or loan arrangement
Does message generated by the campaign include URL link in SMS?
Sample of an embedded link that will be sent to subscribers.
Does message generated by the campaign include phone number in SMS?
Subscriber help keywords. Multiple keywords are comma separated without space.
Help message of the campaign.
Message flow description.
Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided.
Does campaign utilize pool of phone numbers?
Subscriber opt-in keywords. Multiple keywords are comma separated without space.
Subscriber opt-in message.
Subscriber opt-out keywords. Multiple keywords are comma separated without space.
Subscriber opt-out message.
Link to the campaign's privacy policy.
Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.
Alphanumeric identifier of the reseller that you want to associate with this campaign.
Message sample. Some campaign tiers require 1 or more message samples.
Message sample. Some campaign tiers require 2 or more message samples.
Message sample. Some campaign tiers require 3 or more message samples.
Message sample. Some campaign tiers require 4 or more message samples.
Message sample. Some campaign tiers require 5 or more message samples.
Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /10dlc/enum/usecase operation to retrieve list of valid sub-usecases
Does campaign responds to help keyword(s)?
Does campaign require subscriber to opt-in before SMS is sent to subscriber?
Does campaign support subscriber opt-out keyword(s)?
Tags to be set on the Campaign.
Is terms and conditions accepted?
Link to the campaign's terms and conditions.
Campaign usecase. Must be of defined valid types. Use /10dlc/enum/usecase operation to retrieve usecases available for given brand.
Failover webhook to which campaign status updates are sent.
Webhook to which campaign status updates are sent.
Example request
{
"webhookFailoverURL": "https://webhook.com/93711262-23e5-4048-a966-c0b2a16d5963",
"webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93"
}Response
Successful Response
Age gated content in campaign.
Campaign subscription auto-renewal status.
Campaign recent billed date.
Display or marketing name of the brand.
Unique identifier assigned to the brand.
Unique identifier for a campaign.
Campaign status
Unix timestamp when campaign was created.
Alphanumeric identifier of the CSP associated with this campaign.
Summary description of this campaign.
Does message generated by the campaign include URL link in SMS?
Sample of an embedded link that will be sent to subscribers.
Does message generated by the campaign include phone number in SMS?
Failure reasons if campaign submission failed
Subscriber help keywords. Multiple keywords are comma separated without space.
Help message of the campaign.
Indicates whether the campaign has a T-Mobile number pool ID associated with it.
Indicates whether the campaign is registered with T-Mobile.
Indicates whether the campaign is suspended with T-Mobile.
Message flow description.
Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP.
When the campaign would be due for its next renew/bill date.
Does campaign utilize pool of phone numbers?
Subscriber opt-in keywords. Multiple keywords are comma separated without space.
Subscriber opt-in message.
Subscriber opt-out keywords. Multiple keywords are comma separated without space.
Subscriber opt-out message.
Link to the campaign's privacy policy.
Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations.
Alphanumeric identifier of the reseller that you want to associate with this campaign.
Message sample. Some campaign tiers require 1 or more message samples.
Message sample. Some campaign tiers require 2 or more message samples.
Message sample. Some campaign tiers require 3 or more message samples.
Message sample. Some campaign tiers require 4 or more message samples.
Message sample. Some campaign tiers require 5 or more message samples.
Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.
Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /10dlc/enum/usecase operation to retrieve list of valid sub-usecases
Campaign submission status
Does campaign responds to help keyword(s)?
Does campaign require subscriber to opt-in before SMS is sent to subscriber?
Does campaign support subscriber opt-out keyword(s)?
Unique identifier assigned to the brand by the registry.
Unique identifier assigned to the campaign by the registry.
Is terms & conditions accepted?
Link to the campaign's terms and conditions.
Campaign usecase. Must be of defined valid types. Use /10dlc/enum/usecase operation to retrieve usecases available for given brand.
Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use /registry/enum/vertical operation to retrieve verticals available for given brand, vertical combination.
This field is deprecated.
Failover webhook to which campaign status updates are sent.
Webhook to which campaign status updates are sent.
Example response
{
"brandDisplayName": "ABC Mobile",
"brandId": "d2ca9d69-641b-4131-83fa-5d0744f4c8a9",
"campaignId": "823d6b1a-6ed6-41a3-9c50-c8ff41b682ba",
"campaignStatus": "TCR_ACCEPTED",
"tcrBrandId": "BBRAND1",
"tcrCampaignId": "CCAMP1",
"webhookFailoverURL": "https://example.com/failover-webhook",
"webhookURL": "https://example.com/webhook"
}