Update project task comment

Update project task comment 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
string
required
Body Params

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

Write one task comment.

content is the same rich-text HTML the SPA composer posts, and it is the
mention SOURCE: @ spans carrying the task-comment marker become user
mentions, and a customer:{id} span becomes a portal-customer mention. The
mention TARGETS are validated in the application service against the
project's own visible users and its one mentionable customer — a target the
caller may not reach is a 422 BEFORE the comment is written, never a
silently dropped mention on a comment that answered 201.

parent_id (a reply) is scoped to the task in the path, so a comment id
from another task reads as not-found rather than confirming it exists.

string
required
length ≤ 10000

The comment, as HTML. Markup outside the comment editor's allowlist (scripts, event handlers, styles, unknown elements) is removed on write, and a comment left with nothing to show is refused. 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 | null
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
*/*