Skip to main content
POST
/
client
/
email-templates
/
{id}
/
render-preview
Render template preview
curl --request POST \
  --url http://localhost:8080/api/v1/client/email-templates/{id}/render-preview \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": 123,
  "include_default_vars": true,
  "vars": {}
}
'
{
  "data": {
    "contact_id": 123,
    "html_body": "<string>",
    "include_default_vars": true,
    "preview_text": "<string>",
    "resolved_vars": {},
    "subject": "<string>",
    "template_id": 123,
    "text_body": "<string>"
  },
  "errors": [
    {
      "condition": "format",
      "error": "Invalid email format",
      "key": "email"
    }
  ],
  "message": "Operation successful",
  "meta": {},
  "success": true
}

Authorizations

Authorization
string
header
required

JWT Bearer token or raw API key via Authorization header

Path Parameters

id
integer
required

Template ID

Body

application/json

Render preview payload

contact_id
integer
include_default_vars
boolean
vars
object

Response

OK

data
object
errors
object[]
message
string
Example:

"Operation successful"

meta
object
success
boolean
Example:

true