Skip to main content
PATCH
/
api
/
v3
/
instance
/
workspaces
/
{id}
Partially update a workspace
curl --request PATCH \
  --url https://paradigm-preprod.lighton.ai/api/v3/instance/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "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,
  "company": {
    "id": 123,
    "name": "<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

Body

V3 API: Request serializer for instance-level workspace updates (admin-only endpoint)

​
name
string
Maximum string length: 100
​
description
string

Response

Workspace updated successfully

V3 Response serializer for instance-level workspace operations.

​
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
​
used_storage
number<double>
required
​
files_count
integer
required
​
company
object
required