API Docs / Operations / Task - Workflows / Preview Workflow Step Email

Preview Workflow Step Email

GET /tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/preview

Generates a preview of the email that would be sent by a SendEmail workflow step.
Renders subject and body with resolved Liquid tokens and tenant branding,
and resolves all To/CC recipients from contacts, users, and static addresses.
Does not send the email or change step status.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

groupNumber* path integer (int32)
stepNumber* path integer (int32)
taskCode* path string

Responses

401 Unauthorized – Invalid or missing API key