Skip to content

Update Subtask

PUT
/tasks/{task_id}/subtasks/{subtask_id}

Patch a subtask. Omitted fields are left alone.

Two exceptions worth knowing. An explicit null on due_date, assignee_id or task_type CLEARS that field, which is different from omitting it. And records: [] clears every record link, while omitting records leaves them unchanged.

expected_updated_at makes the update conditional: if the stored row has moved on, the write is refused instead of overwriting someone else’s edit.

Authorizations

Parameters

Path Parameters

task_id
required

Parent task id (UUID).

string

Parent task id (UUID).

subtask_id
required

Subtask id (UUID).

string

Subtask id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Patch a subtask. Omitted fields are left alone.

records is the exception: an EMPTY list clears every record link, while omitting it leaves the links unchanged.

object
assignee_id
Any of:
string
assignee_name
Any of:
string
clear_reminder
Any of:
boolean
description
Any of:
string
due_date
Any of:
string
expected_updated_at
Any of:
string
priority
Any of:
integer
records
Any of:
Array<object>
object
key
additional properties
any
reminder_at
Any of:
string
status
Any of:
string
tags
Any of:
Array<string>
<= 20 items
task_type
Any of:
string
title
Any of:
string
visibility
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string