API Docs / Schemas / ClientConfirmationStepConfigDto

ClientConfirmationStepConfigDto

Configuration for ClientConfirmation workflow steps.
Email template is configured in ClientPortalSettings, not per-step.

Properties

Name Type Description
subjectLinestring

Optional email subject line override. When set, replaces the content block's subject.
Supports Liquid template syntax (e.g., "Action required — {{ Client.Name }}").
When null/empty, the subject from the ClientPortalSettings content block is used.

Optional email subject line override. When set, replaces the content block's subject.
Supports Liquid template syntax (e.g., "Action required — {{ Client.Name }}").
When null/empty, the subject from the ClientPortalSettings content block is used.

messageHtml*string

HTML message displayed on the public confirmation page.
Supports Liquid template syntax (e.g., {{ Client.Name }}).

HTML message displayed on the public confirmation page.
Supports Liquid template syntax (e.g., {{ Client.Name }}).

buttonText*string

Text for the confirmation button on the public page.

Text for the confirmation button on the public page.

thankYouMessageHtml*string

HTML message displayed after the client confirms.
Supports Liquid template syntax.

HTML message displayed after the client confirms.
Supports Liquid template syntax.

recipientContactTypesarray of enum

Client contact types to send the confirmation email to.

Main Billing Payroll Accounts Director Psc

Client contact types to send the confirmation email to.

Main Billing Payroll Accounts Director Psc

additionalEmailAddressesarray of string

Static email addresses to send the confirmation email to.

Static email addresses to send the confirmation email to.

notifyAssigneeOnConfirmationboolean

Whether to send a notification to the step's assigned user when the client confirms.

Whether to send a notification to the step's assigned user when the client confirms.

chaseFrequencyDaysinteger

Override for how often (in days) to chase this confirmation.
When null, the tenant-level default is used.

Override for how often (in days) to chase this confirmation.
When null, the tenant-level default is used.

JSON Example

{
  "subjectLine": "string",
  "messageHtml": "string",
  "buttonText": "string",
  "thankYouMessageHtml": "string",
  "recipientContactTypes": [
    "Main"
  ]
}

Contained in Schemas