Skip to main content
POST
Send SMS
Sends a single transactional SMS for the authenticated organization. Requires the SMS marketplace integration and a configured messaging provider. See Messaging overview for prerequisites and billing.

Endpoint

Headers

Request body

Common

string
required
Destination phone number (E.164 recommended, e.g. +5491112345678). Length limits apply (validated server-side).
integer
Optional index for the org’s Twilio SMS sender list in integration config (-1 or omit for platform default behavior, depending on provider). Same semantics as other SMS features in the app.
object
Replacements for {{placeholders}} in the template or inline body. Default {}.

Mode A — Stored template

string (UUID)
required
Message template with channel sms.
Do not send body in this mode.

Mode B — Inline body

Do not send templateId.
string
required
SMS text. Max ~4,000 characters. May include {{variables}} replaced via templateParams.

Example — template

Example — inline with placeholders

Success response

Common errors (400)

  • SMS integration not active or provider not configured
  • Insufficient balance / no pack execution when the integration has a cost
  • templateId and body both sent
  • Template not found or channel is not sms
  • Body empty after rendering
Errors are in English in the error field when success is false.