Sign in

v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Update Task

This API endpoint updates a task.

patch/v1/tasks/{id}

Path parameters

idstring required

The id of the task to update.

Request body

namestring

The name of the task.

descriptionstring

The description of the task.

statusstring

The status of the task.

internalUserIdstring

The uuid of the internal user assigned to this task.

clientIdstring

The uuid of the client user assigned to this task.

companyIdstring

The uuid of the company assigned to this task. If assigning to a client user field should be required as well.

dueDatestring

The date the task is due, in RFC3339 format.

isArchivedboolean

Whether to archive the task or not.

Response

200

archivedBystring
archivedDatestring
clientIdstring
companyIdstring
completedBystring
completedByUserTypestring
completedDatestring
createdBystring
createdDatestring
creatorTypestring
deletedBystring
deletedDatestring
descriptionstring
dueDatestring
idstring
isArchivedboolean
isDeletedboolean
labelstring
namestring
objectstring
parentTaskIdstring
sourcestring
statusstring
templateIdstring
attachmentsobject[]

Example response

{
  "clientId": "aead02ad-bd03-4956-8177-7bd8a24b99e4",
  "companyId": "fadfaa-123g-1235-23412-kjgaliw1241g",
  "createdBy": "27024189-ea18-40a7-a5cf-48579c352dee",
  "createdDate": "2025-05-06T13:24:22Z",
  "creatorType": "internalUser",
  "description": "<p>Bow before me mortals</p>",
  "id": "b941c6ab-9cac-4fb2-9a11-8830396e3f2e",
  "label": "TES-089",
  "name": "Task name",
  "object": "task",
  "parentTaskId": "9fccce1a-644b-4331-9741-113d504e7dee",
  "source": "api",
  "status": "todo"
}