PreviewWorkflowStepEmailRequest

Previews the email of a SendEmail workflow step while it is being built, before the workflow is
saved and before any task exists.

A workflow is a practice-wide template with no client and no dates of its own, and one template
fans out to many clients, so the preview cannot infer its context: the client and the task start
date are supplied here instead.

Properties

Name Type Description
stepConfig*EmailStepConfigDto
clientCode*string

The client to render the email for. Tokens resolve against this client's data.

The client to render the email for. Tokens resolve against this client's data.

startDate*string

The task start date to anchor the preview on. Date tokens (VAT period, tax quarter, tax month,
calendar month and quarter) resolve relative to it, exactly as they would for a task started
on that date.

The task start date to anchor the preview on. Date tokens (VAT period, tax quarter, tax month,
calendar month and quarter) resolve relative to it, exactly as they would for a task started
on that date.

JSON Example

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

Used By Operations