Preview Step Email

POST /tenants/{tenant}/workflows/preview-step-email

Renders a SendEmail workflow step's email as the chosen client would receive it, anchored on the supplied task start date. Takes the step configuration in the body rather than reading a saved workflow, so an unsaved step can be previewed mid-edit. Placeholders that resolve to nothing are listed on unresolvedTokens. Nothing is sent or stored.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

{
  "stepConfig": {
    "contentBlockCode": "string",
    "subjectLine": "string",
    "bodyHtml": "string",
    "recipientIncludeBusinessEmail": false,
    "recipientContactTypes": [
      "..."
    ]
  },
  "clientCode": "string",
  "startDate": "2024-01-01"
}

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
404 Not Found