Types

DocumentUpdate

The body that changes a document. Send only the fields you change.

name
string
The new name. A name already used in the folder is numbered.
folder_id
string (uuid)
The folder to move it into. It must be a folder you can see. Permissions inherited from the old folder are stripped and the new folder's inherited.
description
string | null
A note kept with the document. Send null to clear it.
metadata
object | null
Keys to merge into the document's metadata. A null value removes that key.
access
object
Groups of users who may read and write the document without being listed in its permissions.
allow_download
boolean | null
Whether people may download the document. Null follows the organisation's document settings. Needs the manage-user-documents permission.
apply_watermark
boolean | null
Whether downloads are watermarked. Null follows the organisation's document settings. Needs the manage-user-documents permission and organisation watermarking on.

Used by (1)