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> <Info title="Subscription Level">This endpoint requires the Professional plan or higher.</Info>

Authentication

AuthorizationBearer

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

Path parameters

documentSpaceIdstringRequiredformat: "uuid"
The document space id.

Request

The document space to update.
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
idstring or nullformat: "uuid"
createdOnstring or nullformat: "date-time"
createdBystring or nullformat: "uuid"
updatedOnstring or nullformat: "date-time"
updatedBystring or nullformat: "uuid"
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.