EmailStepConfigDto

Configuration for SendEmail workflow steps.
Used for both workflow template definition and task workflow step instance customization.
All properties must be provided when creating or updating.

Properties

Name	Type	Description
contentBlockCode	string	Content block code for the email template. Must reference an existing Email category content block that defines the subject and body using Liquid syntax. Mutually exclusive with SubjectLine/BodyHtml — provide one or the other.
Content block code for the email template. Must reference an existing Email category content block that defines the subject and body using Liquid syntax. Mutually exclusive with SubjectLine/BodyHtml — provide one or the other.
subjectLine	string	Inline email subject line with Liquid template syntax. Use instead of ContentBlockCode for simple emails that don't need a reusable content block. Must be provided together with BodyHtml. Mutually exclusive with ContentBlockCode.
Inline email subject line with Liquid template syntax. Use instead of ContentBlockCode for simple emails that don't need a reusable content block. Must be provided together with BodyHtml. Mutually exclusive with ContentBlockCode.
bodyHtml	string	Inline email body HTML with Liquid template syntax. Use instead of ContentBlockCode for simple emails that don't need a reusable content block. Must be provided together with SubjectLine. Mutually exclusive with ContentBlockCode.
Inline email body HTML with Liquid template syntax. Use instead of ContentBlockCode for simple emails that don't need a reusable content block. Must be provided together with SubjectLine. Mutually exclusive with ContentBlockCode.
recipientIncludeBusinessEmail	boolean	Whether to include the client's business email (the email address on the client record) as a To recipient.
Whether to include the client's business email (the email address on the client record) as a To recipient.
recipientContactTypes	array of enum	Client contact types for To recipients. Resolved from the task's client contacts at execution time. Main Billing Payroll Accounts Director Psc Secretary
Client contact types for To recipients. Resolved from the task's client contacts at execution time. Main Billing Payroll Accounts Director Psc Secretary
recipientUserTypes	array of enum	User types for To recipients. Resolved from client team assignments or task ownership at execution time. Note: SpecificUser is not applicable for email recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
User types for To recipients. Resolved from client team assignments or task ownership at execution time. Note: SpecificUser is not applicable for email recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
additionalEmailAddresses	array of string	Static email addresses for To recipients. Use for external recipients or email addresses not in the system.
Static email addresses for To recipients. Use for external recipients or email addresses not in the system.
ccIncludeBusinessEmail	boolean	Whether to include the client's business email as a CC recipient.
Whether to include the client's business email as a CC recipient.
ccContactTypes	array of enum	Client contact types for CC recipients. Main Billing Payroll Accounts Director Psc Secretary
Client contact types for CC recipients. Main Billing Payroll Accounts Director Psc Secretary
ccUserTypes	array of enum	User types for CC recipients. Note: SpecificUser is not applicable for email recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
User types for CC recipients. Note: SpecificUser is not applicable for email recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
ccEmailAddresses	array of string	Static email addresses for CC recipients.
Static email addresses for CC recipients.
bccIncludeBusinessEmail	boolean	Whether to include the client's business email as a BCC recipient.
Whether to include the client's business email as a BCC recipient.
bccContactTypes	array of enum	Client contact types for BCC recipients. Main Billing Payroll Accounts Director Psc Secretary
Client contact types for BCC recipients. Main Billing Payroll Accounts Director Psc Secretary
bccUserTypes	array of enum	User types for BCC recipients. Note: SpecificUser is not applicable for email recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
User types for BCC recipients. Note: SpecificUser is not applicable for email recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
bccEmailAddresses	array of string	Static email addresses for BCC recipients.
Static email addresses for BCC recipients.
attachments	array of CodeAndNameDto	Practice documents (code + name) attached to the email on every send. Auto-executed steps attach them automatically; the manual compose dialog pre-seeds them as removable attachments. Maximum 10 attachments, combined size up to 15MB (validated on save).
Practice documents (code + name) attached to the email on every send. Auto-executed steps attach them automatically; the manual compose dialog pre-seeds them as removable attachments. Maximum 10 attachments, combined size up to 15MB (validated on save).
senderSource	enum	PracticeDefault TaskAssignee StepAssignee ClientManager ClientServiceManager ClientPartner ClientAssociate SpecificMailbox
PracticeDefault TaskAssignee StepAssignee ClientManager ClientServiceManager ClientPartner ClientAssociate SpecificMailbox
senderMailboxCode	string	The email connection to send from when SenderSource is SpecificMailbox. Ignored otherwise, and required when SenderSource is SpecificMailbox.
The email connection to send from when SenderSource is SpecificMailbox. Ignored otherwise, and required when SenderSource is SpecificMailbox.

JSON Example

{
  "contentBlockCode": "string",
  "subjectLine": "string",
  "bodyHtml": "string",
  "recipientIncludeBusinessEmail": false,
  "recipientContactTypes": [
    "Main"
  ]
}

Contained in Schemas

UpdateWorkflowStepRequest Request DTO for updating workflow step properties. Supports updating status, assignment, and step-ty...
WorkflowStepDto DTO for workflow steps within a workflow group. Used for both create/update requests and GET respons...
WorkflowStepProgressDto Represents the progress of a single workflow step within a TaskItem. Contains both the step template...