Skip to content

Update Task Settings

PUT
/tasks/settings

Change how a parent task completes. ORG ADMIN ONLY.

The app gates this twice - require_admin_access on the route and an owner/admin role check in the body. The route gate is re-declared here; the body check reads the role off the principal build_api_principal resolves from the validated key, so a machine key (no human, no role) is refused exactly as the app would refuse a member.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors UpdateTaskSettingsRequest. The app accepts exactly these three modes.

object
parent_completion_mode
Any of:
string
Allowed values: manual auto_complete require_subtasks_done

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