Request
This endpoint expects an object.
namestringOptional
A name for the campaign.
Response
The request has succeeded.
idstringformat: "uuid"
The unique identifier of the campaign.
namestringOptional
A name for the campaign.
statestringOptional
The current state of the campaign.
sms_use_casestringOptional
An SMS Use Case category for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED, MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL, UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).
sub_use_caseslist of stringsOptional
A sub use case category for MIXED or LOW_VOLUME_MIXED campaigns (CUSTOMER_CARE, HIGHER_EDUCATION, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION, DELIVERY_NOTIFICATION, FRAUD_ALERT).
campaign_verify_tokenstringOptional
Campaign Verify token. Required if sms use case is POLITICAL_SECTION_527.
descriptionstringOptional
A description for the campaign. Please use at least 40 characters.
sample1stringOptional
Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters.
sample2stringOptional
Sample 2.
sample3stringOptional
Sample 3.
sample4stringOptional
Sample 4.
sample5stringOptional
Sample 5.
dynamic_templatesstringOptional
If your messaging content will be modified in any way beyond what you shared in your templates, please describe the nature of how the content will change.
message_flowstringOptional
Please describe the call to action/message flow your intended recipients will experience.
opt_in_messagestringOptional
Please share the message subscribers receive when they opt in.
opt_out_messagestringOptional
Please share the message subscribers receive when they opt out.
help_messagestringOptional
Please share the message subscribers receive when they request help.
opt_in_keywordsstringOptionalDefaults to START
Opt in keywords that subscribers can use.
opt_out_keywordsstringOptionalDefaults to STOP
Opt out keywords that subscribers can use.
help_keywordsstringOptionalDefaults to HELP
Help keywords that subscribers can use.
number_pooling_requiredbooleanOptional
Will 50 or more numbers be used with this single campaign? If so, please enter true.
number_pooling_per_campaignstringOptional
If you will be using number pooling, please provide an explanation as to why it is needed.
direct_lendingbooleanOptional
Will this campaign include content related to direct lending or other loan agreements?
embedded_linkbooleanOptional
Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted.
embedded_phonebooleanOptional
Are you using an embedded phone number (except the required HELP information contact phone number)?
age_gated_contentbooleanOptional
Will this campaign include any age gated content as defined by carrier and CTA guidelines?
lead_generationbooleanOptional
Is there any intent of this campaign to generate leads?
csp_campaign_referencestringOptional
If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit)
status_callback_urlstringOptional
Optional: Specify a URL to receive webhook notifications when your campaign’s state changes. See the 10DLC status callback docs for the webhook payload.
created_atdatetimeOptional
Timestamp when the campaign was created.
updated_atdatetimeOptional
Timestamp when the campaign was last updated.
