Update Document

Updates properties of an existing document. Supports partial updates via JSON for:

  • title (string) — Rename the document. Must be non-empty, at most 300
    characters, and cannot start or end with whitespace.
  • parent (string | number | null) — Move the document to a different folder or repository. Accepts a numeric folder ID or a repo_-prefixed repository ID. Supports moving documents into (but not out of) repositories.
Path Params
uuid
required
Body Params

string
customTags
array of strings
customTags
Headers
string
required
Defaults to 1
Responses

400

Bad Request. Title must be non-empty when included. Title must be at most 300 characters. Title must not start or end with whitespace. Invalid parent ID. Must be either a string prefixed with repo_ (for repositories) or a number. Custom tag values must be non-empty when included. Custom tag values must not start or end with whitespace.

403

Forbidden. The app making the request does not have permission to the document, or the document does not exist.

409

Conflict. A conflict occurred when saving the document.

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