Update project task

Update project task in the credential-bound company. Idempotency-Key is required and stores the terminal response for safe retries for 24 hours. If-Match is required with the latest ETag; stale versions return 412. This changes draft or operational data without posting accounting entries. Requires the project-tasks:write OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Fields accepted to update project task. The schema identifies required and optional values.

The public create/update contract for a task.

One class for both verbs, the way S2's project request and P13's transfer
request are shared: the field list is identical and only the required set
and the create-only fields differ.

PUT is the documented sparse update (§4.5): every rule is sometimes, so
a field the client did not send keeps its stored value.

WHAT THIS REQUEST DELIBERATELY REFUSES

  • project_id and parent_id after creation. Re-parenting a task moves it
    between two authorization scopes (and, for parent_id, between two
    ordering ladders); the domain has no move-project operation and inventing
    one behind a sparse PUT would relocate a task's whole history silently.
  • task_list_id, before_id and position on BOTH verbs after creation:
    filing and ordering are relative instructions over a dense ladder, not
    resource state, so they belong to POST /project-tasks/{id}/move, which
    renumbers the siblings under one lock. A sparse PUT that also renumbered
    every sibling would be a very surprising PUT.
  • author_id, author_customer_id, sequence_number, priority_weight:
    server-owned. The sequence number is stamped into the human task key.

The start_date <= due_date pair is bounded by the SAME rule builders the
SPA's task requests use ({@see ValidatesProjectTaskDateOrder}); the service
re-checks the merged pair under the row lock, because two concurrent
single-field writes can each pass their own rules.

string
required

missing, NOT prohibited: prohibited passes for an explicit
null, and a null here reaches fill() and writes it — project_id
and position are NOT NULL (a 500), and parent_id: null would
silently promote a subtask to a root task with no task list.
missing fails on PRESENCE, whatever the value is.

string | null
string
required
length ≤ 255
string | null

The description, as HTML. Markup outside the task editor's allowlist (scripts, event handlers, styles, unknown elements) is removed on write. A value with no HTML in it is taken as plain text: it is escaped (an entity it already holds, such as &amp;, stays one) and its line breaks kept, so R&D is stored and returned as <p>R&amp;D</p>.

string
required
string | null

Required on create unless the task is a subtask, and refused
outright alongside parent_id: a subtask is ordered within its
parent and carries no task list of its own. An explicit null is
accepted with a parent — it says the same thing.

string
string
uuid | null
string | null
date | null
date | null
integer | null
0 to 9999
integer | null
0 to 59
string | null
enum
Allowed:
label_ids
array of strings | null
label_ids
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*