Update assignment

Update a task assignment's assignee, due date and status. Setting the status to 6 (Done) or 8 (Unable to Complete) closes the assignment and moves the person on to the connected next task(s), or removes them from the workflow when there is none; reason/comments are recorded as a note on the person. Setting it to 7 (Reassign) requires a reason and notifies the workflow's managers. First retrieve the current assignment from /api/workflows/{workflow}/assignments/{id}, apply your changes, then send back the full object.

Required permission: Full Write Workflows

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the workflow.

int32
required
≥ 1

The id of the assignment (from /api/workflows/assignments).

Body Params

The details of the assignment

status
object | null
required

The entry's status. When updating an assignment, provide the id of the new status: 4 = Not Started, 5 = In Progress, 6 = Done, 7 = Reassign, 8 = Unable to Complete.

date-time | null
required

When the assignment is due (UTC). Required when updating.

assignee
object | null

The person the assignment is assigned to. Required when updating; only the id is used. Assigning a different person notifies them by email.

string | null

Why the assignment is being reassigned (status 7) or marked unable to complete (status 8); required for those statuses. Recorded as a note on the person.

string | null

Optional comments recorded as a note on the person when the assignment is completed (status 6).

next
array of objects | null

The next-step options to send the person to when completing the assignment; only the id of each entry is used. Valid options come from nextSteps.

next
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json