Update Task

put

https://{hostname}/api/custom-entity/v1/tasks/{taskId}

Use this API to update an existing task for an object.

🗒
Things to Know

This API only supports objects created via Object Manager, including Projects, Models, and Datasets.

Path Params

taskId

uuid

required

The unique identifier of the task.

Body Params

taskName

string

required

length between 1 and 512

The name of the task.

description

string

length ≤ 2000

The description of the task.

assigneeId

uuid

The unique identifier of the user assigned as an assignee on the task.

assigneeEmail

string

length between 5 and 255

The email address of the user assigned as an assignee on the task.

collaborators

array of objects

The details of the collaborators assigned to the task.

collaborators

deadline

date-time

The date and time by which the task should be completed.

status

string

enum

The status of the task.

Allowed:

context

object

The contextual details of the task.

priority

string

enum

Defaults to MEDIUM

The priority level of the task.

Allowed:

isRequired

boolean

Defaults to false

This flag indicates whether the task is required.

sourceType

string

length between 1 and 16

The type of source that created the task.

sourceId

uuid

The unique identifier of the source that created the task.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK

429Too Many Requests. For more information, see API Rate Limits.