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
executionMode*enum

Auto Manual

Auto Manual

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.

Content block code for the email template.
Must reference an existing Email category content block that defines the subject and body using Liquid syntax.

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

{
  "executionMode": "Auto",
  "contentBlockCode": "string",
  "recipientContactTypes": [
    "Main"
  ],
  "recipientUserTypes": [
    "TaskOwner"
  ],
  "additionalEmailAddresses": [
    "string"
  ]
}

Contained in Schemas