Skip to main content
POST

Authentication

This endpoint requires API key authentication. Include your API key in the Authorization header.

Request Body

string
required
The destination phone number in E.164 format (e.g., +15551234567)
string
required
The text content of the message to send
string
The sender phone number. If not provided, the default messaging service number will be used

Response

string
The unique identifier for the sent message from the provider
string
The current status of the message (e.g., “queued”, “sent”, “delivered”)

Error Responses

string
The error code indicating what went wrong
string
Additional details about the error

Error Codes

  • missing_params (400) - Required parameters are missing from the request
  • provider_not_configured (400) - The workspace doesn’t have a messaging provider configured
  • send_failed (500) - Message sending failed due to an internal error