API Docs / Operations / Task - Workflows / Update Workflow Step

Update Workflow Step

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

Updates workflow step properties including status, assignment, time tracking, and email configuration.

Supports updating:

  • Status changes (validates dependencies)
  • User assignment
  • Time spent tracking
  • Email configuration (SendEmail steps only, before execution)

Email configuration uses PUT semantics - when provided, all fields must be included.
Configuration can only be updated on SendEmail steps that are not Completed status.

Example Request:
{
"status": "Completed",
"timeSpent": 45
}

Parameters

NameTypeDescription
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

The update request with new values

{
  "status": "NotStarted",
  "blockedReason": "string",
  "assignedUserCode": "string",
  "timeSpent": 0,
  "emailStepConfiguration": {
    "executionMode": "...",
    "contentBlockCode": "string",
    "recipientContactTypes": [
      "..."
    ],
    "recipientUserTypes": [
      "..."
    ],
    "additionalEmailAddresses": [
      "..."
    ]
  }
}

Responses

401 Unauthorized - Invalid or missing API key