POST
/api/v1/messages/actions/renderRender a transactional message
Renders a transactional message without sending it and returns the rendered subject and message bodies. Supply sender_id and type, along with a recipient and content configuration as required for message rendering. Use the response to inspect the rendered output before sending a message.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Transactional message parameters supplied under data; include the required sender_id and type.
dataobjectoptional
200Returns the rendered subject, HTML body, and plain-text body without sending the message.
dataobjectoptional
Error handling
The request requires sender_id and type. Provide a recipient using contact_id, external_contact_id, or recipient_email, and provide message content through template_id or a body field appropriate to type.