API Docs / Schemas / EmailRecipientConfig

EmailRecipientConfig

Configuration for resolving email recipients from client contacts, user roles, and static addresses.
Used by PCL settings, workflow steps, and any feature that needs configurable email recipients.

Properties

Name Type Description
includeBusinessEmailboolean

Whether to include the client's business email (the email address on the client record,
as opposed to a contact's email address)

Whether to include the client's business email (the email address on the client record,
as opposed to a contact's email address)

contactTypesarray of enum

Client contact types to include (e.g. Main, Billing, Payroll)

Main Billing Payroll Accounts Director Psc

Client contact types to include (e.g. Main, Billing, Payroll)

Main Billing Payroll Accounts Director Psc

userTypesarray of enum

User role types to include (e.g. ClientManager, ClientPartner).
TaskOwner is not applicable outside workflow steps.

TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign

User role types to include (e.g. ClientManager, ClientPartner).
TaskOwner is not applicable outside workflow steps.

TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign

emailAddressesarray of string

Static email addresses to include

Static email addresses to include

JSON Example

{
  "includeBusinessEmail": false,
  "contactTypes": [
    "Main"
  ],
  "userTypes": [
    "TaskOwner"
  ],
  "emailAddresses": [
    "string"
  ]
}

Used By Operations

Contained in Schemas