API v1 ReferenceDocument Spaces

Updates the document space with the specified id.

<Check> <b>Required Permissions</b>: The user has to be an admin.</Check>

Subscription Level
This endpoint requires the Professional plan or higher.

Path parameters

documentSpaceIdUUIDRequired
The document space id.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestring or nullOptional>=0 characters<=1000 characters
The name of the document space.
emojistring or nullOptional>=0 characters<=25 characters
The emoji of the document space.
colorstring or nullOptional>=0 characters<=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
idUUIDOptional
createdOndatetimeOptional
createdByUUIDOptional
updatedOndatetimeOptional
updatedByUUIDOptional
namestring or nullOptional
The name of the document space.
emojistring or nullOptional
The emoji of the document space.
colorstring or nullOptional
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.
workspaceAccessLevelstring or nullOptional

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 objectsOptional
The contributors of this document space.
teamslist of objectsOptional
The teams this document space is connected to.