template_send

Send a templated message to one or more recipients. Provide the template once — inline in message_template with [placeholder] tokens, or as a saved template by its event key — then supply each recipient's values in template_variables.

  • Set a default sender and event at the top level; override either per recipient.
  • Up to 250 recipients per request.
  • An unknown event, or neither event nor message_template, fails the whole request.

Response. HTTP 200 with a task_id and one entry per message. status is false when any message failed: failed entries come first and carry error (hex code) and details; accepted entries carry message_uuid (and conversation_uuid on two-way channels). Match entries by internal_id. Final delivery status is sent asynchronously to your configured webhook.

Authentication: stream token in the Authorization header (see Authentication in the API Overview).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Default sender for every recipient. An alphanumeric sender ID or a phone number registered on the stream. Omit it to use the stream's default sender.

Default template: an eventKey from Stream event templates. An unknown key fails the whole request.

Inline template text instead of event, with [name] or {name} placeholders. Used only when event is not set.

recipients
array of objects
required
length ≤ 250

The recipients, up to 250 per request.

Recipients*
object | null

Metadata stored on new conversations (inbox).

array | null

Candidate senders, used only when no sender is set on the message, the request or the stream: a sender allowed for the destination is picked at random. When none is allowed, the whole request fails with 0x61.

Send at this time instead of now (ISO 8601 date-time).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json