Skip to main content
POST
cURL
Refer to Authentication for information on how to obtain a bearer token. This endpoint requires the message.sms.send.oneway API client authorization scope to send one way messages. You can set up scopes on the API Clients page.

Rate Limit

This endpoint is rate limited to 400 messages per second.

Request Modes

The required type field selects one of four request modes. Free-form modes compose raw message text; template modes send a pre-approved template by referencing its templateId (see SMS Templates).

Limits

Request Schemas

Send individually tailored free-form messages to multiple recipients.Each item in messages:
Important: for TemplateSendToEach and TemplateSendToMany, after all parameters are substituted, the final message must not exceed 960 characters. A longer resolved message is rejected with Resolved content cannot be longer than 960 characters. There is no truncation or fallback.

Errors

General errors

Template parameter validation errors

When parameter validation fails, the response is HTTP 400 with desc set to Template parameter validation failed. For TemplateSendToEach, errors are keyed by recipient phone number:
For TemplateSendToMany, errors are returned under a single errors key:

Common parameter validation messages

Success Response

On success the endpoint returns HTTP 200:

Authorizations

Authorization
string
header
required

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

Path Parameters

serviceId
string
required

Unique identifier for the messaging service

Body

application/json

Message details for sending to one or multiple recipients

Send message to a single recipient

type
enum<string>
required

Indicates sending to a single recipient

Available options:
SendToEach
messages
object[]
required

Messages and recipients

receiptRequest
object

Response

Message(s) sent successfully

desc
object

The response