Update Workflow Step
Updates a workflow step by group number and step number with comprehensive field support.
Allows updating any combination of:
- Status (validates dependencies are met before allowing progress)
- Assigned user (validates user exists in tenant)
- Notes (replaces or clears existing notes)
- Time spent tracking
Status change validation:
- Steps cannot be started/completed if dependencies are not met
- Status changes automatically set completion metadata when appropriate
- Dependency validation ensures workflow integrity
Use this endpoint to:
- Mark steps as started, completed, blocked, or skipped
- Reassign steps to different users
- Add progress notes and documentation
- Track time spent on individual steps
- Update multiple properties in a single API call
Example Request:
{
"status": "Completed",
"notes": "Client documents reviewed and approved",
"timeSpent": 45
}
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| groupNumber* | path integer (int32) | The group number (sort order) from the URL |
The group number (sort order) from the URL |
||
| stepNumber* | path integer (int32) | The step number to update from the URL |
The step number to update from the URL |
||
| taskCode* | path string | The task code from the URL |
The task code from the URL |
||
Request Body*
The update request with new values
{
"status": "NotStarted",
"assignedUserCode": "string",
"notes": "string",
"timeSpent": 0,
"hasUpdates": false
}Responses
200 OK
401 Unauthorized - Invalid or missing API key