Skip to main content
PATCH
Change a task

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public id of one of the member's tasks.

Body

application/json

Fields to change; omitted fields stay as they are.

title
string

What to do.

Required string length: 1 - 10000
Pattern: ^[^\u0000]*[^\s\u0000][^\u0000]*$
notes
string | null

Optional detail; null clears it.

Maximum string length: 10000
Pattern: ^[^\u0000]*$
due_at
string<date-time> | null

Due time; null clears it.

priority
enum<string>

Priority.

Available options:
low,
normal,
high
contact_id
string<uuid> | null

One of the member's contacts; null detaches. Any other id returns 422.

Response

The changed task.

One task.

status
integer
required
data
object
required

A member's to-do, optionally about one of their contacts.

meta
object
required

Envelope metadata present on every response.