Sign in

v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
Stages

Update stage

Requires the JOBEDIT security role. Updates a workflow stage, including the user or group responsible for it (displayed as Responsible in the UI).

put/api/workflow/stages/{id}

Path parameters

idstring required

Request body

namestring required

Name of the stage

descriptionstring

Description of the stage

deadlinestring

Date of when the stage ends. Send null to clear it.

Example request

{
  "name": "Stage Example",
  "description": "Stage Description",
  "deadline": "2018-09-29",
  "responsible": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user"
  }
}

Response

Successful response

statusstring
stage_idstring

Example response

{
  "status": "Updated",
  "stage_id": "00000000-0000-0000-0000-000000000000"
}