tasks

Update a Task.

Partial update — omitted fields are left untouched. Admitted for an editor of the task's project (a teammate's task included) or the creator of a task with no project, as on the web; subtasks stay the task owner's. A team viewer is refused with 403 forbidden.

patch/tasks/{id}

Request

  • Base URL: https://restivity.ai/api/v1
  • URL: https://restivity.ai/api/v1/tasks/{id}
  • Auth: OAuth 2 (authorization code, authorization URL https://restivity.ai/oauth/authorize, token URL https://restivity.ai/api/oauth/token, scopes: tasks:write)

Path parameters

idstring uuid required

Unique Task identifier.

Request body

titlestring
descriptionstring

description takes HTML or marked text, at most 10,000 characters. HTML is kept as the task editor writes it (<p>, <strong>, <em>, <ul>/<ol> with <li>, <code>, <a href="https://…">) and sanitized by allow-list; marked text — blank-line paragraphs, - and 1. lists, a ### heading opening a block, **bold**, *italic*, `code`, [text](https://…) links, code blocks fenced by three backticks — is rendered by the server into that HTML, so the board shows no asterisks or backticks. In one text the two do not mix: a text holding an HTML tag is stored as sent, markers included. A read returns the HTML in description and the same content without tags in description_text

status'todo' | 'in_progress' | 'completed' | 'archived'

Lifecycle state of a task.

priority'low' | 'medium' | 'high' | 'urgent'
project_idstring uuid nullable
due_datestring date-time nullable
is_for_todayboolean
is_importantboolean
is_urgentboolean
estimated_pomodorosinteger
is_recurringboolean

false stops the repeat. On the template of a materialized series its occurrences still to come (due today or later, not completed) go to the Trash and the past ones stay; the answer carries series_change.

recurrence_model'materialized' | 'reminder_only' nullable

reminder_only (with is_recurring: true and its recurring_frequency) turns a materialized series into a reminder: its occurrences still to come go to the Trash, the past ones stay, and it is due on its next occurrence from today; the answer carries series_change.

recurring_frequency'daily' | 'weekly' | 'monthly' | 'yearly' nullable
recurring_end_datestring date-time nullable
recurring_daysinteger[] nullable
recurrence_start_datestring date-time nullable

When the series starts (the first occurrence is on or after this day). Defaults to today. For a reminder_only master the server sets due_date to the first occurrence and owns it from then on (a client due_date is ignored); for a materialized master due_date stays null and every child occurrence carries its own.

assigned_tostring uuid nullable
project_status_idstring uuid nullable
tag_idsstring[]

Response

The updated Task.

idstring uuid required
user_idstring uuid required
project_idstring uuid nullable required
titlestring required
descriptionstring required

The stored HTML, as the task editor writes it (sanitized). To show it to a person read description_text.

description_textstring required

The description as plain text: every tag removed, one line per block, - / N. before list items, entities decoded — the same shape as a comment’s content_text. Show THIS to a person; description is the stored HTML. Read-only

status'todo' | 'in_progress' | 'completed' | 'archived' required

Lifecycle state of a task.

priority'low' | 'medium' | 'high' | 'urgent' required
orderinteger nullable required
due_datestring nullable required
is_for_todayboolean required
is_importantboolean required
is_urgentboolean required
estimated_pomodorosinteger required
completed_pomodorosinteger required
is_recurringboolean required
recurring_frequencystring nullable required
recurring_end_datestring nullable required
recurring_daysinteger[] nullable required
parent_recurrence_idstring uuid nullable required
recurrence_model'materialized' | 'reminder_only' nullable required
recurrence_start_datestring nullable required

RES-115 — the series anchor ("Starts on") of a recurring master, a civil date at UTC midnight. The deadline is only a deadline: a reminder_only master's due_date is the occurrence it is currently on (it rolls forward when the occurrence is completed or skipped), a materialized master has none (each child occurrence carries its own). NULL on non-recurring rows and on child occurrences.

completed_atstring nullable required
assigned_tostring uuid nullable required
codestring nullable required
created_atstring required
updated_atstring required
deleted_atstring nullable required
urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.