Skip to main content
POST
Create campaign

Authorizations

Authorization
string
header
required

Authorization: Bearer tlv_…

Headers

Idempotency-Key
string

Optional. A unique value (e.g. a UUID) per operation, up to 255 characters. Retrying with the same key and body returns the first response instead of doing it again. Kept 24 hours.

Example:

"5f1c2b0e-8d6a-4c1f-9a43-2b7e0f6d1a90"

Body

application/json
name
string
required

For your own reference.

Example:

"November offer"

message
string
required

The SMS text. Personalise with {first_name}, {name} or {phone}.

Example:

"Hi {first_name}, 20% off until Friday. Reply STOP to opt out."

contactListIds
string[]

Contact lists to send to.

tags
string[]

Send to contacts carrying any of these tags.

Example:
manualPhones
string[]

Extra numbers.

sendType
enum<string>

Default immediate.

Available options:
immediate,
scheduled
scheduledAt
string<date-time>

Required when sendType is scheduled.

Response

Success