API v1 ReferenceDocuments

Updates the document with the specified id.

<Check title="Required Permissions" icon="key">The user must have at least `write` permissions for the specified document.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

documentIdstringRequiredformat: "uuid"
The id of the document to update.

Request

The document form data with the updated information.
namestring or nullOptional0-1000 characters
The name of the document.
documentSpaceIdstring or nullOptionalformat: "uuid"
The id of the document space.
parentIdstring or nullOptionalformat: "uuid"
The id of the document's parent document.
projectIdstring or nullOptionalformat: "uuid"
The id of the project this document references.
taskIdstring or nullOptionalformat: "uuid"
The id of the task this document references.
emojistring or nullOptional0-25 characters
The emoji of the document.
isPrivatebooleanOptional
Whether the document is private.
orderdouble or nullOptional
The order of the document in either the list of private docs, the referenced document space or in the referenced project.
workspaceAccessLevelenum or nullOptional

Determines the level of access to this document granted to all workspace users. Can be either null (inherited), none, read, or manage.

Allowed values:
isHiddenForConnectUsersboolean or nullOptional
Whether the document is hidden for connect users.

Response

OK
idstring or nullformat: "uuid"
The id of the entity.
createdOndatetime or null
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
namestring or null
The name of the document.
currentDocumentVersionIdstring or nullformat: "uuid"
The id of the current document version.
documentSpaceIdstring or nullformat: "uuid"
The id of the document space.
documentSpaceobject or null
parentIdstring or nullformat: "uuid"
The id of the document's parent document.
projectIdstring or nullformat: "uuid"
The id of the project this document references.
projectobject or null
taskIdstring or nullformat: "uuid"
The id of the task this document references.
emojistring or null
The emoji of the document.
isPrivateboolean or null
Whether the document is private.
orderdouble or null
The order of the document in either the list of private docs, the referenced document space or in the referenced project.
isExternalboolean or null
Whether the document belongs to an external project.
isHiddenForConnectUsersboolean or null
Whether the document is hidden for connect users.
contributorslist of objects or null
The contributors of this document.
teamslist of objects or null
The teams this document is connected to.
workspaceAccessLevelstring or null

Determines the level of access to this document granted to all workspace users. Can be either not set (no access), read, or manage.

inheritedWorkspaceAccessFromDocumentIdstring or nullformat: "uuid"
The id of the document the workspace access level permission has been inherited from.
inheritedWorkspaceAccessFromDocumentobject or null
movedToTrashOndatetime or null
The date the document has been moved to the trash
movedToTrashBystring or nullformat: "uuid"
The id of the user that moved the document to the trash.
rootDocumentCreatedBystring or nullformat: "uuid"
The user id of the creator of the root document of this document's document tree.

Errors