Skip to content

Update Task Settings

PUT
/org/settings/tasks

Set the org’s default task visibility and note-taking toggles.

default_visibility is a privilege-sensitive setting: moving it to public exposes every task created afterwards to the whole organisation. Admin-gated, and the handler re-checks the role.

An EMPTY patch is refused (422) rather than no-opped, because an empty body on this route is always a caller bug.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors UpdateTaskSettingsRequest. Partial update, but not an EMPTY one.

The app refuses a patch that sets nothing (422) rather than no-opping, and that refusal is worth keeping: an empty body is always a caller bug, and a silent 200 hides it.

default_visibility and parent_completion_mode are Literals here where the app takes str and rejects an unknown value from inside the handler. Same outcome, one layer earlier, and the legal values are in the schema.

object
default_visibility
Any of:
string
Allowed values: public team private
mentions_enabled
Any of:
boolean
notes_anywhere_enabled
Any of:
boolean
notify_on_mention
Any of:
boolean
parent_completion_mode
Any of:
string
Allowed values: manual auto_complete require_subtasks_done
selection_toolbar_enabled
Any of:
boolean

Responses

200

Successful Response

object
data
required

An open envelope for one settings block, document or brand artefact.

OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as “the product does not have that setting”.

The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.

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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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