workspace

Update Workspace

Update workspace metadata such as name, description, or public status. Changes are persisted to the database.

Only developers can change the is_public field. When making a workspace public, the backend uses the Workspace-Key header to get the workspace key.

patch/api/workspace/{workspace_ext_id}

Path parameters

workspace_ext_idstring required

Headers

workspace-keystring

Request body

namestring nullable

descriptionstring nullable

is_publicboolean nullable

Response

Successful Response

external_idstring required

namestring required

descriptionstring nullable required

is_publicboolean required

created_by_ext_idstring required

updated_by_ext_idstring nullable

created_atstring date-time required

updated_atstring date-time required

wrapped_keystring nullable

shared_conversation_countinteger

private_conversation_countinteger

shared_document_countinteger

private_document_countinteger

user_files_mbnumber

Changes

Changed in 5 of the 34 revisions of this API.9120

Jan 17, 2026b91e4b449d56515See the full diff
- ▲
  removed the required property users/items/email from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property users/items/encryption_public_key from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property users/items/external_id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property users/items/family_name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property users/items/given_name from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property users/items/picture from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property users/items/conversation_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property users/items/document_count to the response with the 200 status
  response-optional-property-added
- ○
  added the required property users/items/joined_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property users/items/role to the response with the 200 status
  response-required-property-added
- ○
  added the required property users/items/user to the response with the 200 status
  response-required-property-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 25, 2025aa4b06f8dede45See the full diff
- ▲
  the response property updated_by_ext_id became optional for the status 200
  response-property-became-optional
- ▲
  removed the required property users/items/last_name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property users/items/name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property users/items/user_ext_id from the response with the 200 status
  response-required-property-removed
- ○
  added the optional property users/items/picture to the response with the 200 status
  response-optional-property-added
- ○
  added the required property users/items/encryption_public_key to the response with the 200 status
  response-required-property-added
- ○
  added the required property users/items/external_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property users/items/family_name to the response with the 200 status
  response-required-property-added
- ○
  added the required property users/items/given_name to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 3, 2025d6c3e911a2631See the full diff
- ○
  added the optional property user_files_mb to the response with the 200 status
  response-optional-property-added
Oct 28, 2025849d5e8732f67See the full diff
- ○
  added the new optional header request parameter workspace-key
  new-optional-request-parameter
- ○
  added the optional property private_conversation_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property private_document_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property shared_conversation_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property shared_document_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property users to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property wrapped_key to the response with the 200 status
  response-optional-property-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 13, 20255ab425658de02See the full diff
- ○
  added the new optional request property is_public
  new-optional-request-property
- ○
  added the required property is_public to the response with the 200 status
  response-required-property-added

Full history