v1

latestOpenAPI 3.0.1MIT2026-07-22241852.5 KB

Send a one-time text

Renders an SMS template with the supplied variables and sends it to one phone number. A 200 means the message was accepted and queued, not yet delivered — use the returned messageId with the status endpoint. Sandbox API keys are rejected.

post/text/send

Request body

destinationstring required

US phone number. 3313048434, 13313048434, and +1 (331) 304-8434 are all accepted.

templateIdinteger required

The template to send. Must belong to your organization's account.

variablesobject required

Values substituted into the template's {placeholder} tokens. Use {} if the template has none. If any placeholder is left unresolved, the request fails with 400 rather than texting a literal {token}.

debtorIdstring required

Your reference for this recipient (e.g. your account or reference number). Forwarded as-is; replies and the message record are tracked against it.

Response

Message accepted and queued.

successboolean required

messageIdstring required

Delivery-tracking ID. Use it with the status endpoint.