Create a Campaign

brandId  REQUIRED

string (UUID)

Unique ID for the brand associated with the campaign.

campaignName  REQUIRED

string, max length: 255, min length: 0

Campaign name.

description  REQUIRED

string, max length: 4096, min length: 40

Detailed description of the campaign.

sender

string

pattern: ^(0|[1-9][0-9]*)$

10DLC phone number used to send SMS messages. Must be 11 digits.

usecase  REQUIRED

string (UUID)

Campaign use case. Use the List Use Cases API to retrieve a list of usecaseName values that can be used in this field.

subUsecases

array of strings (UUID)

Campaign sub use cases. Use the List Use Cases API to retrieve a list of usecaseName values that can be used in this field.

embeddedLink  REQUIRED

boolean, default: false

Whether the message generated by the campaign includes a URL link. Note that public URL shorteners (bityly, tinyurl) are not accepted.

embeddedPhone  REQUIRED

boolean, default: false

Whether the message generated by the campaign includes a phone number (other than the required HELP information contact phone number).

numberPool  REQUIRED

boolean, default: false

Whether the campaign utilizes a pool of phone numbers.

ageGated  REQUIRED

boolean, default: false

Whether the campaign includes any age-gated message content.

directLending  REQUIRED

boolean, default: false

Whether the campaign includes any message content related to direct lending or other loan arrangements.

subscriberOptin  REQUIRED

boolean, default: true

Whether the campaign requires the subscriber to opt-in before messages can be sent to the subscriber.

subscriberOptout  REQUIRED

boolean, default: false

Whether the campaign supports subscriber opt-out keyword(s).

subscriberHelp  REQUIRED

boolean, default: true

Whether the campaign responds to help keyword(s).

affiliateMarketing

boolean, default: false

Whether the message content is controlled by any affiliate marketing other than the brand.

mnoIds

array of strings

List of MNO network IDs for the MNOs the campaign will be submitted to. Default is all MNOs if no value is provided.

messageFlow  REQUIRED

string, max length: 2048, min length: 40

Message describing how a subscriber can opt-in to the campaign.

helpMessage  REQUIRED

string, max length: 255, min length: 0

Help message for the campaign.

optinMessage

string, max length: 320, min length: 20

Opt-in message shown to subscribers.

optoutMessage  REQUIRED

string, max length: 320, min length: 20

Opt-out message shown to subscribers.

autoRenewal

boolean, default: true

Whether the campaign subscription will automatically renew at the end of the billing cycle.

sample1

string, max length: 1024, min length: 20

Message sample. Some campaign tiers require up to 5 message samples.

sample2

string, max length: 1024, min length: 20

Message sample. Some campaign tiers require up to 5 message samples.

sample3

string, max length: 1024, min length: 20

Message sample. Some campaign tiers require up to 5 message samples.

sample4

string, max length: 1024, min length: 20

Message sample. Some campaign tiers require up to 5 message samples.

sample5

string, max length: 1024, min length: 20

Message sample. Some campaign tiers require up to 5 message samples.