API v1 ReferenceDocument Spaces

Updates the document space with the specified id.

<Note title="Subscription Level" icon="layer-group">This endpoint requires the `Professional` plan or higher.</Note> <Check title="Required Permissions" icon="key">The user must be an admin.</Check>

Authentication

AuthorizationBearer

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

Path parameters

documentSpaceIdstringRequiredformat: "uuid"
The id of the document space.

Request

The model used to update the document space.
namestring or nullOptional0-1000 characters
The name of the document space.
emojistring or nullOptional0-25 characters
The emoji of the document space.
colorstring or nullOptional0-14 characters
The color of the document space for display purposes in the app. Can be null when no color assigned.
orderdouble or nullOptional
The order of the document space in the list of document spaces.
workspaceAccessLevelenum or nullOptional

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

Allowed values:

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 space.
emojistring or null
The emoji of the document space.
colorstring or null
The color of the document space for display purposes in the app. Can be null when no color assigned.
orderdouble or null
The order of the document space in the list of document spaces.
workspaceAccessLevelstring or null

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

contributorslist of objects or null
The contributors of this document space.
teamslist of objects or null
The teams this document space is connected to.

Errors