Update a workspace

⚠️ ALPHA ENDPOINT - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

Partially update a given workspace. The authenticated user must be an owner of the workspace.

Fields:

• name (string, optional): Desired workspace name (max 100 characters, cannot be empty)
• description (string, optional): Desired workspace description. Send empty string or null to clear.

Restrictions:

• Only CUSTOM workspaces can be updated (PERSONAL and COMPANY workspaces cannot be modified)
• Only workspace OWNER can update (EDITOR role, instance admins, and company admins cannot use this endpoint)
• Only name and description can be updated (members cannot be updated via this endpoint)

Note: To update workspace members, use the dedicated member management endpoints.

PATCH /api/v3/workspaces/{id}

Update a workspace

cURL

curl --request PATCH \
  --url https://paradigm.lighton.ai/api/v3/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "members": "<unknown>"
}
'

200

{
  "id": 123,
  "name": "<string>",
  "workspace_type": "<string>",
  "document_upload_method": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "user_role": "<string>",
  "used_storage": 123,
  "files_count": 123,
  "summaries": [
    {
      "language": "<string>",
      "summary": "<string>"
    }
  ]
}

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

name · string

description · string

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.

Response

200

application/json

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

user_role · string · required · read-only

used_storage · number<double> · required

files_count · integer · required

summaries · object[] · required · read-only

Show child attributes