Update project document

Update project document 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 project document. The schema identifies required and optional values.

Sparse PATCH: sometimes on every field, so an omitted key is untouched and
an explicit key is applied — never the other way round (§4.5).

A document carries no content of its own. title is the root page's title
and project_id is its owning project; neither may be blanked, because
detaching a document from its project silently changes who can read it and
that is a deliberate internal action, not a metadata edit.

project_id carries filled for exactly that reason: sometimes alone
accepts "", which is not an omission, and the empty string then reached the
lookup and came back as a 404 rather than a 422.

string
length ≤ 64
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
*/*