API Docs / Schemas / WorkflowStepEmailPreviewDto

WorkflowStepEmailPreviewDto

Preview of a workflow step email with rendered content and resolved recipients.
Returned before sending so the user can review what will be sent.

Properties

Name Type Description
subjectstring

Rendered subject line with Liquid tokens resolved.

Rendered subject line with Liquid tokens resolved.

bodyHtmlstring

Rendered body HTML with header/footer/theme applied and Liquid tokens resolved.

Rendered body HTML with header/footer/theme applied and Liquid tokens resolved.

toRecipientsarray of EmailPreviewRecipientDto

Resolved To recipients with names and email addresses.

Resolved To recipients with names and email addresses.

ccRecipientsarray of EmailPreviewRecipientDto

Resolved CC recipients with names and email addresses.

Resolved CC recipients with names and email addresses.

bccRecipientsarray of EmailPreviewRecipientDto

Resolved BCC recipients with names and email addresses.

Resolved BCC recipients with names and email addresses.

fromConfigCodestring

Suggested From connection (email config code): the client manager match if one applies, else the tenant default.

Suggested From connection (email config code): the client manager match if one applies, else the tenant default.

attachmentsarray of WorkflowStepEmailPreviewAttachmentDto

Pre-specified practice document attachments from the step configuration.
Metadata only (no content). Documents that no longer exist are omitted;
send-time validation surfaces the breakage.

Pre-specified practice document attachments from the step configuration.
Metadata only (no content). Documents that no longer exist are omitted;
send-time validation surfaces the breakage.

JSON Example

{
  "subject": "string",
  "bodyHtml": "string",
  "toRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ],
  "ccRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ],
  "bccRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ]
}

Used By Operations