Skip to main content
PATCH
Update a company workspace

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

The unique identifier of the workspace.

Body

V3 Request serializer for updating a workspace in the user's company.

name
string
Maximum string length: 100
description
string
datasource
object

Datasource configuration to convert this workspace into a read-only synced workspace. Company admin only. Cannot be undone. Fields: type (googledrive|sharepoint|servicenow|webscrapper), name, credentials, filter_criteria.

Response

Workspace updated successfully

V3 Response serializer for company workspace creation and retrieval.

id
integer
required
name
string
required
workspace_type
string
required
document_upload_method
string
required
description
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
files_count
integer
required
user_role
required
  • owner - owner
  • editor - editor
  • viewer - viewer
  • `` -
Available options:
owner,
editor,
viewer
used_storage
number<double>
required
sync
object | null
required
scoped_api_keys
object[]
required
read-only