Skip to main content
POST
Create and launch a campaign

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
required

Campaign name

Example:

"Summer Promo"

text
string
required

Message content

Example:

"Get 20% off this summer!"

senderId
string
required

Sender ID

Example:

"ECSEND"

recipients
string[]

Array of phone numbers

Example:
rawReceivers
string

Comma or newline separated phone numbers

Example:

"+25884000001,+25884000002"

contactBookName
string

Name of existing contact book to use

Example:

"My Contacts"

Response

Campaign created and launched

success
boolean
Example:

true

campaignId
string
Example:

"clx456def"

status
string
Example:

"COMPLETED"

recipientCount
integer
Example:

100