DocumentRequestStepConfigDto

Configuration for DocumentRequest workflow steps.
Used for both workflow template definition and task workflow step instance customization.

Properties

Name	Type	Description
title*	string	The title for the document request to create. Describes what documents are being requested from the client.
The title for the document request to create. Describes what documents are being requested from the client.
description	string	Optional description providing details about what documents are needed.
Optional description providing details about what documents are needed.
deadlineDaysFromExecution	integer	Number of days from step execution to set as the client-facing deadline. For example, 14 means the client has 14 days from when the step runs. Null means no deadline is set on the document request.
Number of days from step execution to set as the client-facing deadline. For example, 14 means the client has 14 days from when the step runs. Null means no deadline is set on the document request.
notifyUserCode	string	Code of the user to notify when the client submits a response. Defaults to the step's assigned user at execution time. Only set this to override the default — most workflows should leave it null.
Code of the user to notify when the client submits a response. Defaults to the step's assigned user at execution time. Only set this to override the default — most workflows should leave it null.
recipientContactTypes	array of enum	Client contact types to send the document request email to. Resolved at execution time from the task's associated client contacts. Main Billing Payroll Accounts Director Psc
Client contact types to send the document request email to. Resolved at execution time from the task's associated client contacts. Main Billing Payroll Accounts Director Psc
additionalEmailAddresses	array of string	Static email addresses to send the document request email to.
Static email addresses to send the document request email to.
chaseFrequencyDays	integer	Override for how often (in days) to chase this document request. When null, the tenant-level default is used.
Override for how often (in days) to chase this document request. When null, the tenant-level default is used.

JSON Example

{
  "title": "string",
  "description": "string",
  "deadlineDaysFromExecution": 1,
  "notifyUserCode": "string",
  "recipientContactTypes": [
    "Main"
  ]
}

Contained in Schemas

UpdateWorkflowStepRequest Request DTO for updating workflow step properties. Supports updating status, assignment, time tracki...
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...