Skip to main content
PATCH
Update a 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

name
string

Workspace name (max 100 characters, cannot be empty). When sent together with deleted_at: null (restore), the workspace is restored under this name — used to resolve a collision when the original name was re-taken by a live workspace during the grace period.

description
string

Workspace description. Send empty string or null to clear. May be sent together with deleted_at: null (restore) to set the description as part of the restore request; a name collision rejects the whole request before the description is applied. members and datasource are not accepted on a restore request — restore first, then PATCH them.

members
any

Members with roles in format {"users": [{"id": <user_id>, "role": "owner|editor|viewer"}, ...], "groups": [{"id": <group_id>, "role": "owner|editor|viewer"}, ...]}. Role defaults to viewer if not specified. REPLACES all existing members.

datasource
object

Datasource configuration to convert this workspace into a read-only synced workspace. Workspace OWNER (or a role granting workspace edit/delete) only. Cannot be undone.

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
summaries
object[]
required
read-only
sync
object | null
required
scoped_api_keys
object[]
required
read-only