Skip to main content
POST
Send outbound SMS to a list of leads

Example

Each lead object is passed through as leadInfo on the per-recipient send, so mode: agent can personalize openers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agentId
string
required
Minimum string length: 1
leads
array
required
Minimum array length: 1
message
string
mode
enum<string>
default:direct
Available options:
direct,
agent
from
string
Pattern: ^\+
campaignId
string
options
object

Advanced options for outbound SMS delivery and conversation handling.

contactMethodsPriority
string[]

Preferred lead phone fields, e.g. ['userPhone', 'userID', 'phone'].

Response

Successful response

success
boolean
required
total
number
required
sent
number
required
failed
number
required
results
array
required