Skip to main content
POST
Send an SMS message

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
agentId
string<uuid>
required

UUID of the Agent. Must exist and have SMS channel configured.

Example:

"32d8fc98-be1e-4d32-a12e-146f397fb1cb"

phoneNumber
string
required

Phone number of the recipient in E.164 format (e.g., +1234567890).

Example:

"+12345678900"

message
string
required

SMS message body. Must be between 1 and 1600 characters.

Required string length: 1 - 1600
Example:

"Hello! Your appointment is confirmed for tomorrow at 10:00 AM."

Response

Success

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"SMS message sent successfully"

data
object