Endpoint
Overview
Send a message to a new or existing recipient by address. The message is queued for delivery and the response identifies the conversation thread, which you can use for follow-up sends and history reads.Sending requires your account to have at least one assigned sending number; otherwise the request returns
403. Check your numbers with GET /v1/me.Each send costs 0.15 credits, debited when the request is accepted and refunded automatically if delivery fails. If your balance can’t cover it, the request returns
402 with Insufficient balance. See Pricing.Request Body
The recipient’s address: a phone number (any common format — it is canonicalized to
+1XXXXXXXXXX for US numbers) or an email-style iMessage handle.The message body to send.
Which service to send over:
imessage (blue bubble, the default) or sms (green bubble).Which of your assigned sending numbers to send from. Defaults to your first assigned number, so you can omit it when your account holds a single number. Passing a number not assigned to your account returns
403. See your numbers with GET /v1/me.Response
Returns202 Accepted — the message is queued and delivered asynchronously.
true when the message was queued successfully.ID of the conversation thread for this recipient on the sending number (created if it didn’t exist).
The sending number the message goes out from.
Internal ID of the queued send.
Always
queued.