UpdateWorkflowStepRequest

Request DTO for updating workflow step properties.
Supports updating status, assignment, and step-type configuration.
At least one property must be provided.

API Usage:

PUT /api/tenants/{tenant}/tasks/{taskCode}/workflow/steps/{stepId}
Supports updating multiple fields at once or individual fields
Validates that changes are appropriate and permissions are met

Example Usage:

PUT /api/tenants/acme/tasks/TASK-001/workflow/steps/123
{
    "status": "Completed",
    "assignedUserCode": "john.doe"
}

Properties

Name	Type	Description
status	enum	NotStarted InProgress Blocked Completed Skipped
NotStarted InProgress Blocked Completed Skipped
blockedReason	string	The reason the step is blocked (optional). Only used when setting status to "Blocked".
The reason the step is blocked (optional). Only used when setting status to "Blocked".
assignedUserCode	string	The user code to assign this step to (optional). Must be a valid user code for an active user in the tenant. If null, the assignment will not be changed.
The user code to assign this step to (optional). Must be a valid user code for an active user in the tenant. If null, the assignment will not be changed.
assignedTeamCode	string	The team code to assign this step to (optional, independent of user assignment). If null, the team assignment will not be changed.
The team code to assign this step to (optional, independent of user assignment). If null, the team assignment will not be changed.
emailStepConfiguration	EmailStepConfigDto
documentRequestStepConfiguration	DocumentRequestStepConfigDto
clientConfirmationStepConfiguration	ClientConfirmationStepConfigDto
checklist	array of ChecklistItemDto	Checklist items for this workflow step. Replaces all existing checklist items when provided.
Checklist items for this workflow step. Replaces all existing checklist items when provided.
hasUpdates	boolean	Validates that at least one property is being updated
Validates that at least one property is being updated

JSON Example

{
  "status": "NotStarted",
  "blockedReason": "string",
  "assignedUserCode": "string",
  "assignedTeamCode": "string",
  "emailStepConfiguration": {
    "contentBlockCode": "string",
    "subjectLine": "string",
    "bodyHtml": "string",
    "recipientIncludeBusinessEmail": false,
    "recipientContactTypes": [
      "..."
    ]
  }
}

Used By Operations

PUT Update Workflow Step
/tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}