Register a 10DLC Campaign

Authorizations

Authorization

string

header

required

Bearer token using appid (Authorization: Bearer )

Path Parameters

brand_id

string

required

Brand ID.

Example:

"BM20QP9"

Body

application/json

Campaign registration request.

affiliate_marketing

boolean

required

Indicates whether the Campaign is used for affiliate marketing

Example:

false

age_gated

boolean

required

Indicates whether the Campaign messages contain age-gated content

Example:

false

auto_renewal

boolean

required

Indicates whether the Campaign should be automatically renewed

Example:

true

direct_lending

boolean

required

Indicates whether the Campaign messages contain direct lending content

Example:

true

embedded_links

boolean

required

Indicates whether the Campaign messages contain embedded links

Example:

true

embedded_phones

boolean | null

required

Indicates whether the Campaign messages contain embedded phone numbers

Example:

true

embedded_link_sample

string | null

required

An embedded link sample

description

string

required

The Campaign description

Example:

"Our campaign aims to …"

optin_workflow

string

required

The opt-in workflow - the process through which consumers opt-in to the Campaign

Example:

"Our SMS ..."

help

boolean

required

Indicates whether the campaign has a help system (e.g. keyword: HELP, INFO) that subscribers can use or not.

Example:

true

help_keywords

string

required

A comma-separated list of HELP keywords. The HELP keywords are case-insensitive.

Example:

"help"

help_message

string

required

An acknowledgement to be sent when a HELP keyword is received

Example:

"For help, please visit www.site.com. To opt out, reply STOP."

optin

boolean

required

Indicates whether the campaign requires a subscriber to opt-in before receiving messages or not.

Example:

true

optin_keywords

string

required

A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive.

Example:

"begin,start"

optin_message

string

required

An acknowledgement to be sent when an OPT-IN keyword is received

Example:

"You are now opted-in for help please reply HELP, to stop please reply STOP"

optout

boolean

required

Indicates whether the campaign has an opt-out system (e.g. keyword: STOP, QUIT) that subscribers can use or not.

Example:

true

optout_keywords

string

required

A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive.

Example:

"stop,quit,unsubscribe"

optout_message

string

required

An acknowledgement to be sent when an OPT-OUT keyword is received

Example:

"You are now opted out and will receive no further messages"

name

string

required

A user-defined Campaign name

Example:

"My first campaign"

sample1

string

required

Message sample

Example:

"Your verification code is XXXXXX"

sample2

string | null

required

Message sample

sample3

string | null

required

Message sample

sample4

string | null

required

Message sample

sample5

string | null

required

Message sample

mock

boolean

required

Indicates a mock Campaign. The mock Campaigns cannot be used to send production traffic

Example:

false

usecase

string

required

The Campaign use case

Example:

"2FA"

terms_conditions

string

required

A link to the Campaign terms and conditions

Example:

"https://site.com/terms-and-conditions"

privacy_policy

string

A link to the Campaign privacy policy

Example:

"https://site.com/privacy-policy"

Response

10DLC Campaign.

10DLC campaign details.

affiliate_marketing

boolean

required

Indicates whether the Campaign is used for affiliate marketing.

Example:

false

age_gated

boolean

required

Indicates whether the Campaign messages contain age-gated content.

Example:

false

auto_renewal

boolean

required

Indicates whether the Campaign should be automatically renewed.

Example:

true

last_bill_date

string | null

required

Date and time the Campaign was last billed in ISO 8601 format. null if the Campaign has never been billed.

Example:

"2024-08-14T11:57:42"

next_bill_date

string | null

required

Date and time the Campaign will be billed next in ISO 8601 format. null if the next billing date is not scheduled.

Example:

"2024-08-14T11:57:42"

direct_lending

boolean

required

Indicates whether the Campaign messages contain direct lending content.

Example:

true

embedded_links

boolean

required

Indicates whether the Campaign messages contain embedded links.

Example:

true

embedded_phones

boolean

required

Indicates whether the Campaign messages contain embedded phone numbers.

Example:

true

embedded_link_sample

string | null

required

Embedded link sample.

brand_id

string

required

Brand ID.

Example:

"BM20QP9"

campaign_id

string

required

Campaign ID.

Example:

"CKLCK95"

description

string | null

required

Campaign description.

Example:

"Our campaign aims to …"

optin_workflow

string | null

required

Opt-in workflow description.

Example:

"Our SMS ..."

feedback

string | null

required

Campaign feedback.

help

boolean

required

Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).

Example:

true

help_keywords

string

required

Comma-separated list of help keywords. Keywords are case-insensitive.

Example:

"help"

help_message

string | null

required

Help message sent upon receiving a help keyword.

Example:

"For help, please visit www.site.com. To opt out, reply STOP."

optin

boolean

required

Indicates whether the Campaign requires subscriber opt-in.

Example:

true

optin_keywords

string

required

Comma-separated list of opt-in keywords. Keywords are case-insensitive.

Example:

"begin,start"

optin_message

string | null

required

Opt-in message sent upon receiving an opt-in keyword.

Example:

"You are now opted-in for help please reply HELP, to stop please reply STOP"

optout

boolean

required

Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).

Example:

true

optout_keywords

string

required

Comma-separated list of opt-out keywords. Keywords are case-insensitive.

Example:

"stop,quit,unsubscribe"

optout_message

string | null

required

Opt-out message sent upon receiving an opt-out keyword.

Example:

"You are now opted out and will receive no further messages"

name

string

required

Campaign name.

Example:

"My first campaign"

created_at

string

required

Date and time the Campaign was created in ISO 8601 format.

Example:

"2024-08-14T11:57:41"

sample1

string | null

required

Message sample.

Example:

"Your verification code is XXXXXX"

sample2

string | null

required

Message sample.

sample3

string | null

required

Message sample.

sample4

string | null

required

Message sample.

sample5

string | null

required

Message sample.

updated_at

string

required

Date and time the Campaign was updated in ISO 8601 format.

Example:

"2024-08-14T11:57:47"

mock

boolean

required

Indicates whether the Campaign is a mock campaign.

Example:

false

usecase

string

required

Campaign use case.

Example:

"2FA"

monthly_fee

string

required

Campaign monthly fee.

Example:

"10.0"

privacy_policy

string | null

required

Example:

"https://site.com/privacy-policy"

terms_conditions

string | null

required

Terms and conditions URL.

Example:

"https://site.com/terms-and-conditions"

status

string

required

Campaign status.

Example:

"APPROVED"

phone_numbers

string[]

required

List of phone numbers associated with the campaign.

Example:

["14358684439", "13193337776", "12673296046"]

Using the APIs

API reference

WebSocket protocol

Register a 10DLC Campaign

Authorizations

Path Parameters

Body

Response