Skip to main content
PATCH
Update a task

Authorizations

Authorization
string
header
required

A pc_… token generated from Settings > API & MCP.

Path Parameters

taskId
string<uuid>
required

Identifier of a row.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
areaId
string<uuid> | null

Identifier of a row.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
conversationPath
string | null

Atelier conversation carrying this delegated task; null un-delegates.

Maximum string length: 1024
deadline
string<date> | null

Local day key, YYYY-MM-DD.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
done
boolean

Shortcut for ticking or unticking.

durationMin
integer | null
Required range: 15 <= x <= 1440
headingId
string<uuid> | null

Heading of the project or area that groups the task. null moves it back to the top. It must belong to the same parent as the task.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
notePath
string | null

Path of a note in the local markdown vault, relative to its root (Projects/Launch.md). When set, the app shows that note instead of the notes field. Do not invent one: it names a file on the user's machine.

Maximum string length: 1024
notes
string

Markdown: bold, italic, headings, lists, quotes, rules, links, inline code, tables and checkboxes. Do not use code blocks (```) or images: the app's editor does not support them and truncates the display from that point on.

Maximum string length: 10000
order
number

Manual position. Fractional values are valid; lower sorts first.

priority
integer

0 none · 1 low · 2 medium · 3 high · 4 “goal of the day”. Out of range is a 400.

Required range: 0 <= x <= 4
projectId
string<uuid> | null

Identifier of a row.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
repeat
object | null

Repeat rule. null stops it repeating.

tags
string[]
Maximum array length: 20
Minimum string length: 1
time
string

Time HH:MM — only meaningful alongside a date.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
title
string
Required string length: 1 - 500
visibility
enum<string>

Who sees this task on shared and social surfaces. Defaults to private on create.

Available options:
public,
anonymized,
private
when

Scheduling: today, anytime (Later), someday (Future), or a YYYY-MM-DD date. Not to be confused with deadline, which is the due date.

Available options:
today,
anytime,
someday

Response

Success.

task
object
required