Update projectdocument page

Update projectdocument page 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-documents: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 projectdocument page. The schema identifies required and optional values.

The public page-content write.

THE CANONICAL RULES ARE BORROWED, NOT COPIED. content_json is validated by
the very rule the internal editor uses — the closure lifted out of
{@see UpsertProjectDocumentPageRequest::rules()} — so the ProseMirror doc
check, the 5 MB byte ceiling and the 100-level depth ceiling can never drift
between the two surfaces. Forking those numbers here is precisely the bug
this arrangement prevents.

WHAT THE PUBLIC API REFUSES THAT THE EDITOR STILL ACCEPTS:

  • content_html: a derived, UNSANITIZED cache the model hides from every
    response. Accepting it would let a client store HTML that some future
    renderer trusts.
  • content: the frozen legacy HTML column. It exists so pre-JSON pages keep
    rendering, not so new HTML can be written.
  • attrs.path media: a raw storage key. Public clients address media by the
    uuid the upload returns; a path is the one shape that could name an object
    outside the document's folder, and the read path signs what it is given.
    Each refusal is a 422 with a stable code, never a silent drop.

string | null
content_json
array of strings
content_json
integer
≥ 0
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
*/*