Skip to main content
PATCH

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

taskId
string<uuid>
required

Task identifier

Body

application/json

Any subset of the task's mutable fields

name
string

Task name

description
string

Task description

status
enum<string>

Task completion status

Available options:
Not Complete,
Complete
deadline
string<date-time>

Task deadline as an ISO 8601 date-time string

entity
object | null

Entity to link the task to, or null to unlink it.

assignees
string[]

Company user IDs to assign the task to (replaces the existing list)

Response

Task updated successfully

A task entity.

id
string<uuid>
required

Task identifier

name
string
required

Task name

description
string
required

Task description (empty string if none)

status
enum<string>
required

Task completion status

Available options:
Not Complete,
Complete
deadline
string<date-time>
required

Task deadline as an ISO 8601 date-time string

entity
object | null
required

Snapshot of the entity this task is linked to (e.g. a claim or policy), or null when the task is not linked to any entity.

assignees
string[]
required

Company user IDs the task is assigned to

createdBy
string | null
required

User ID who created the task

createdAt
string<date-time>
required

When the task was created

updatedAt
string<date-time>
required

When the task was last updated