Update a task

Change an existing task: edit its fields, move it to a different status, or assign it to someone. Every change here is reversible.

Example: “Mark the task ‘Fix login bug’ as done”

Usage: pass the task id and pick what to do with action. update_fields edits the task and needs fields with just the values that change; transition_status needs the new status; assign needs the assignee (a person, an agent, or unassigned).

Response: the updated task with its new field values.

POST /api/v1/business/tasks/update

Update a task

cURL

curl --request POST \
  --url https://api.example.com/api/v1/business/tasks/update \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fields": {
    "title": "<string>",
    "description": "<string>",
    "due_date": "2023-12-25",
    "sort_order": 123,
    "parent_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "assignee": {
    "assignee_id": "<string>"
  }
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identifier": "<string>",
  "title": "<string>",
  "description": "<string>",
  "status": "backlog",
  "priority": "urgent",
  "creator_type": "human",
  "creator_id": "<string>",
  "assignee_type": "human",
  "assignee_id": "<string>",
  "parent_task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "due_date": "2023-12-25",
  "sort_order": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "comment_count": 123,
  "last_comment_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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.

Show child attributes

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.

Show child attributes

Response

200

application/json

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