Skip to main content
Version: 8.5

Update a user task

PATCH 
http://localhost:8080/v1/user-tasks/:userTaskKey

Update a user task with the given key.

Request​

Path Parameters

    userTaskKey int64required

    The key of the user task to update.

Body

    changeset objectnullable

    JSON object with changed task attribute values.

    The following attributes can be adjusted with this endpoint, additional attributes will be ignored:

    • candidateGroups - reset by providing an empty list
    • candidateUsers - reset by providing an empty list
    • dueDate - reset by providing an empty String
    • followUpDate - reset by providing an empty String

    Providing any of those attributes with a null value or omitting it preserves the persisted attribute's value.

    The assignee cannot be adjusted with this endpoint, use the Assign task endpoint. This ensures correct event emission for assignee changes.

    dueDatedate-timenullable

    The due date of the task. Reset by providing an empty String.

    followUpDatedate-timenullable

    The follow-up date of the task. Reset by providing an empty String.

    candidateUsersstring[]nullable

    The list of candidate users of the task. Reset by providing an empty list.

    candidateGroupsstring[]nullable

    The list of candidate groups of the task. Reset by providing an empty list.

    property name*anynullable

    Additional properties allowed.

    actionstringnullable

    A custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "update".

Responses​

The user task was updated successfully.

curl -L -X PATCH 'http://localhost:8080/v1/user-tasks/:userTaskKey' \
-H 'Content-Type: application/json' \
-d '{
  "changeset": {
    "dueDate": "2024-07-29T15:51:28.071Z",
    "followUpDate": "2024-07-29T15:51:28.071Z",
    "candidateUsers": [
      "string"
    ],
    "candidateGroups": [
      "string"
    ]
  },
  "action": "string"
}'
Request Collapse all
Base URL
http://localhost:8080/v1
Parameters
— pathrequired
Body
{

  "changeset": {

    "dueDate": "2024-07-29T15:51:28.071Z",

    "followUpDate": "2024-07-29T15:51:28.071Z",

    "candidateUsers": [

      "string"

    ],

    "candidateGroups": [

      "string"

    ]

  },

  "action": "string"

}