ExecuteWorkflowStepRequest

Optional request body for executing a workflow step.
For document steps: provide documentCodes to link existing documents (manually uploaded or pre-generated from template).
Omit documentCodes to trigger async generation from the step's configured template.
Ignored for other step types.

Properties

Name Type Description
documentCodesarray of string

The codes of existing client documents to link to the step. A Document Approval step can
cover several documents; an Upload a Document step takes exactly one.
Each document must have a ClientApprovalStatus of None or Pending.
When omitted, the step must have a documentTemplateCode configured — the document will be generated asynchronously.

The codes of existing client documents to link to the step. A Document Approval step can
cover several documents; an Upload a Document step takes exactly one.
Each document must have a ClientApprovalStatus of None or Pending.
When omitted, the step must have a documentTemplateCode configured — the document will be generated asynchronously.

JSON Example

{
  "documentCodes": [
    "string"
  ]
}

Used By Operations