Update a task item | Comp AI API

Update a task item in Comp AI. Manage task items and attachments linked to operational entities such as risks and vendors.

PUT /v1/task-management/{id}

Update a task item

cURL

curl --request PUT \
  --url https://api.trycomp.ai/v1/task-management/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "assigneeId": {}
}
'

200

{
  "id": "tski_abc123def456",
  "title": "Review vendor contract",
  "description": {},
  "entityId": "<string>",
  "assignee": {
    "id": "<string>",
    "user": {}
  },
  "createdBy": {
    "id": "<string>",
    "user": {}
  },
  "updatedBy": {
    "id": "<string>",
    "user": {}
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

apikeyoauth2

X-API-Key · string · header · required

API key for authentication

Path Parameters

id · string · required

Task item ID

Example:

"tski_abc123def456"

Body

application/json

title · string

Task title

description · string

Task description

status · enum<string>

Task status

Available options: todo, in_progress, in_review, done, canceled

priority · enum<string>

Task priority

Available options: urgent, high, medium, low

assigneeId · object

Assignee member ID (set to null to unassign)

Response

200 - application/json

Task item updated successfully

id · string · required

Task item ID

Example:

"tski_abc123def456"

title · string · required

Task title

Example:

"Review vendor contract"

description · object · required

Task description

status · enum<string> · required

Task status

Available options: todo, in_progress, in_review, done, canceled

priority · enum<string> · required

Task priority

Available options: urgent, high, medium, low

entityId · string · required

ID of the entity this task belongs to

entityType · enum<string> · required

Type of entity

Available options: vendor, risk

assignee · object · required

Assignee information

Show child attributes

createdBy · object · required

Creator information

Show child attributes

updatedBy · object · required

Last updater information

Show child attributes

createdAt · string<date-time> · required

Creation timestamp

updatedAt · string<date-time> · required

Last update timestamp