documentSpaces

Creates a document space.

Changed on

Creates a document space and assigns the requested workspace access level. The space is inserted into the workspace order. The Basic, Standard and Connect plans allow one active space, including Home.

<Check title="Required Permissions" icon="key">The user must be an admin.</Check>

post/documentspaces

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/documentspaces
  • Auth: HTTP bearer

Request body

namestring nullable

The name of the document space.

emojistring nullable

The emoji of the document space.

colorstring nullable

The color of the document space for display purposes in the app. Can be null when no color assigned.

ordernumber double nullable

The order of the document space in the list of document spaces.

workspaceAccessLevel'none' | 'read' | 'manage'

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

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

The name of the document space.

isExternalboolean

Whether this document space is coming from an external workspace (awork Connect).

emojistring nullable

The emoji of the document space.

colorstring nullable

The color of the document space for display purposes in the app. Can be null when no color assigned.

ordernumber double nullable

The order of the document space in the list of document spaces.

workspaceAccessLevelstring nullable

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostDocumentSpace removed and replaced with documentSpaces_PostDocumentSpace