API Docs / Schemas / EmailStepConfigDto

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
contentBlockCodestring

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.

subjectLinestring

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.

bodyHtmlstring

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.

recipientContactTypesarray of enum

Client contact types for To recipients.
Resolved from the task's client contacts at execution time.

Main Billing Payroll Accounts Director

Client contact types for To recipients.
Resolved from the task's client contacts at execution time.

Main Billing Payroll Accounts Director

recipientUserTypesarray 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

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

additionalEmailAddressesarray 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.

ccContactTypesarray of enum

Client contact types for CC recipients.

Main Billing Payroll Accounts Director

Client contact types for CC recipients.

Main Billing Payroll Accounts Director

ccUserTypesarray of enum

User types for CC recipients.
Note: SpecificUser is not applicable for email recipients.

TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate

User types for CC recipients.
Note: SpecificUser is not applicable for email recipients.

TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate

ccEmailAddressesarray of string

Static email addresses for CC recipients.

Static email addresses for CC recipients.

JSON Example

{
  "contentBlockCode": "string",
  "subjectLine": "string",
  "bodyHtml": "string",
  "recipientContactTypes": [
    "Main"
  ],
  "recipientUserTypes": [
    "TaskOwner"
  ]
}

Contained in Schemas