listmonk unofficial
POST/tx

Send a transactional message to a subscriber

Sends a transactional message to a subscriber. Use subscriber_email or subscriber_id to identify the recipient, and provide message content or a template_id as needed.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

Optional JSON settings for a transactional message to a subscriber.

subscriber_emailstringoptional
The subscriber's email address.
subscriber_idintegeroptional
The integer identifier of the subscriber.
template_idintegeroptional
The integer identifier of the template to use.
from_emailstringoptional
The sender email address.
dataobjectoptional
Additional data for the message.
headersarray<object>optional
An array of message header objects.
messengerstringoptional
The messenger to use for sending the message.
content_typestringoptional
The content type of the message.

1 status code
200Returns a boolean in `data` indicating the result of the send operation.
databooleanoptional

Error handling

Use subscriber_email or subscriber_id to identify the recipient. Provide template_id when selecting a template, and use data, headers, messenger, and content_type to supply any additional message settings.