Skip to main content
POST
Update a task

Headers

x-project-id
string<uuid>
required

Project ID for tenant scoping

X-Workspace-Id
string<uuid> | null

Overrides the key's workspace

X-API-Key
string | null

User API key

Body

application/json
action
enum<string>
required

Which mutation to apply to the task.

Available options:
update_fields,
transition_status,
assign
task_id
string<uuid>
required

Task to update.

fields
TaskUpdate · object | null

Field edits for action=update_fields - only set what changes. Explicit null on title/priority/sort_order is rejected (they can't be cleared this way); omit instead.

status
enum<string> | null

New status for action=transition_status.

Available options:
backlog,
todo,
in_progress,
pending_human_approval,
in_review,
done,
cancelled
assignee
AssignTask · object | null

Assignee for action=assign.

Response

Successful Response

id
string<uuid>
required
project_id
string<uuid>
required
identifier
string
required
title
string
required
description
string | null
required
status
enum<string>
required
Available options:
backlog,
todo,
in_progress,
pending_human_approval,
in_review,
done,
cancelled
priority
enum<string>
required
Available options:
urgent,
high,
medium,
low,
none
creator_type
enum<string>
required
Available options:
human,
ai_agent,
system
creator_id
string | null
required
assignee_type
enum<string>
required
Available options:
human,
ai_agent,
system
assignee_id
string | null
required
parent_task_id
string<uuid> | null
required
page_id
string<uuid> | null
required
schedule_id
string<uuid> | null
required
due_date
string<date> | null
required
sort_order
number
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
comment_count
integer
required
last_comment_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required