Skip to main content
POST
Send an outbound SMS

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json
userNumber
string
required

Recipient phone number (E.164 or normalizable)

messageContent
string
required

SMS body text

phoneProvider
enum<string> | null
default:twilio

SMS provider (twilio/vonage)

Available options:
twilio,
telnyx,
vonage
phoneNumberId
string | null

Phone number ID — assistant number resolved from this if assistantNumber is omitted

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

assistantNumber
string | null

Sender phone number (E.164 or normalizable). Required if phoneNumberId not provided.

assistantId
string | null

Assistant/bot ID sending the SMS

conversationId
string | null

Conversation ID for tracking

workflowId
string | null

Workflow ID for tracking

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

campaignId
string | null

Campaign ID for tracking

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Response

Successful Response