Create a Campaign

POST 
/registry/beta/brands/:id/campaigns

A Campaign belongs to a Brand.

To create a new managed campaign, send a POST request to the Campaign resource with all of the parameters except for csp_campaign_reference.

To create a new self-registered campaign, send a POST request to the same Campaign resource except that you only need to fill out the name and csp_campaign_reference parameters.

Please note: the csp_self_registered parameter has been deprecated and is no longer required.

Permissions

The API token must include the following scopes: Messaging.

Request

Path Parameters

id uuidrequired

Unique ID of the brand

application/json

Body

required

name string
A name for the campaign.
Example: My Campaign
sms_use_case string
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).
Example: MARKETING
sub_use_cases string[]
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).
Example: ["MARKETING","2FA"]
campaign_verify_token string
Campaign Verifiy token. Required if sms use case is POLITICAL_SECTION_527. (Some U.S. wireless carriers require political committees to obtain Campaign Verify verification in order to access special political campaign classes for the new 10DLC text messaging routes. Visit www.campaignverify.org for more information and to obtain your token)
Example: null
description string
A description for the campaign. Please use at least 40 characters.
Example: null
sample1 string
Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters.
Example: this is a sample message your customer might receive
sample2 string
Sample 2.
Example: this is a sample message your customer might receive
sample3 string

Sample 3.

sample4 string

Sample 4.

sample5 string

Sample 5.

dynamic_templates string

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_flow string
Please describe the call to action/message flow your intended recipients will experience.
Example: Users will opt in to receive messages from their doctor through a written form and we will send them an opt in message. Appointment reminders will then be sent ahead of their appointments.
opt_in_message string
Please share the message subscribers receive when they opt in.
Example: Thanks for subscribing. Reply STOP to cancel at any time.
opt_out_message string
Please share the message subscribers receive when they opt out.
Example: You have successfully been opted out. Reply START to opt back in at any time.
help_message string
Please share the message subscribers receive when they opt out.
Example: You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.
opt_in_keywords string
You can share any opt in keywords that subscribers can use here. Default = START
Example: Start,Subscribe,Opt In
opt_out_keywords string
You can share any opt in keywords that subscribers can use here. Default = STOP
Example: Stop,Opt Out,Unsubscribe
help_keywords string
You can share any help keywords that subscribers can use here. Default = HELP
Example: Help,Support,Request Call
number_pooling_required boolean
Will 50 or more numbers be used with this single campaign? If so, please enter true.
Example: true
number_pooling_per_campaign string
If you will be using number pooling, please provide an explanation as to why it is needed.
Example: We have customer reps in every state and they each need their own number with local area code.
direct_lending boolean
Will this campaign include content related to direct lending or other loan agreements?
Example: true
embedded_link boolean
Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted.
Example: false
embedded_phone boolean
Are you using an embedded phone number (except the required HELP information contact phone number)?
Example: false
age_gated_content boolean
Will this campaign include any age gated content as defined by carrier and CTA guidelines?
Example: true
lead_generation boolean
Is there any intent of this campaign to generate leads?
Example: true
csp_campaign_reference string
If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit)
Example: 1231231
status_callback_url string
Optional: Specify a URL to receive webhook notifications when your campaign’s state changes.
Example: https//example.com/handle_callback
terms_and_conditions boolean
I agree to the terms and conditions which do not allow me to use this campaign for affiliate marketing.
Example: true

Responses

201

CREATED

application/json

Schema

Schema

id uuidrequired

The unique id of the campaign.

name string
A name for the campaign.
Example: My Campaign
state string
The current state of the campaign.
Example: pending
sms_use_case string
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).
Example: MARKETING
sub_use_cases string[]
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).
Example: ["MARKETING","2FA"]
campaign_verify_token string
Campaign Verifiy token. Required if sms use case is POLITICAL_SECTION_527. (Some U.S. wireless carriers require political committees to obtain Campaign Verify verification in order to access special political campaign classes for the new 10DLC text messaging routes. Visit www.campaignverify.org for more information and to obtain your token)
Example: null
description string
A description for the campaign. Please use at least 40 characters.
Example: null
sample1 string
Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters.
Example: this is a sample message your customer might receive
sample2 string
Sample 2.
Example: this is a sample message your customer might receive
sample3 string

Sample 3.

sample4 string

Sample 4.

sample5 string

Sample 5.

dynamic_templates string

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_flow string
Please describe the call to action/message flow your intended recipients will experience.
Example: Users will opt in to receive messages from their doctor through a written form and we will send them an opt in message. Appointment reminders will then be sent ahead of their appointments.
opt_in_message string
Please share the message subscribers receive when they opt in.
Example: Thanks for subscribing. Reply STOP to cancel at any time.
opt_out_message string
Please share the message subscribers receive when they opt out.
Example: You have successfully been opted out. Reply START to opt back in at any time.
help_message string
Please share the message subscribers receive when they opt out.
Example: You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.
opt_in_keywords string
You can share any opt in keywords that subscribers can use here. Default = START
Example: Start,Subscribe,Opt In
opt_out_keywords string
You can share any opt in keywords that subscribers can use here. Default = STOP
Example: Stop,Opt Out,Unsubscribe
help_keywords string
You can share any help keywords that subscribers can use here. Default = HELP
Example: Help,Support,Request Call
number_pooling_required boolean
Will 50 or more numbers be used with this single campaign? If so, please enter true.
Example: true
number_pooling_per_campaign string
If you will be using number pooling, please provide an explanation as to why it is needed.
Example: We have customer reps in every state and they each need their own number with local area code.
direct_lending boolean
Will this campaign include content related to direct lending or other loan agreements?
Example: true
embedded_link boolean
Will you be using an embedded link of any kind? Note that public URL shorteners (bitly, tinyurl) will not be accepted.
Example: false
embedded_phone boolean
Are you using an embedded phone number (except the required HELP information contact phone number)?
Example: false
age_gated_content boolean
Will this campaign include any age gated content as defined by carrier and CTA guidelines?
Example: true
lead_generation boolean
Is there any intent of this campaign to generate leads?
Example: true
csp_campaign_reference string
If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit)
Example: 1231231
status_callback_url string
Optional: Specify a URL to receive webhook notifications when your campaign’s state changes.
Example: https//example.com/handle_callback
created_at date-time
updated_at date-time

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Campaign",
  "state": "pending",
  "sms_use_case": "MARKETING",
  "sub_use_cases": [
    "MARKETING",
    "2FA"
  ],
  "campaign_verify_token": null,
  "description": null,
  "sample1": "this is a sample message your customer might receive",
  "sample2": "this is a sample message your customer might receive",
  "sample3": "string",
  "sample4": "string",
  "sample5": "string",
  "dynamic_templates": "string",
  "message_flow": "Users will opt in to receive messages from their doctor through a written form and we will send them an opt in message. Appointment reminders will then be sent ahead of their appointments.",
  "opt_in_message": "Thanks for subscribing. Reply STOP to cancel at any time.",
  "opt_out_message": "You have successfully been opted out. Reply START to opt back in at any time.",
  "help_message": "You have successfully been opted out. Reply SUBSCRIBE to opt back in at any time.",
  "opt_in_keywords": "Start,Subscribe,Opt In",
  "opt_out_keywords": "Stop,Opt Out,Unsubscribe",
  "help_keywords": "Help,Support,Request Call",
  "number_pooling_required": true,
  "number_pooling_per_campaign": "We have customer reps in every state and they each need their own number with local area code.",
  "direct_lending": true,
  "embedded_link": false,
  "embedded_phone": false,
  "age_gated_content": true,
  "lead_generation": true,
  "csp_campaign_reference": "1231231",
  "status_callback_url": "https//example.com/handle_callback",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}