Skip to main content
PATCH
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{id}
Update workspace
curl --request PATCH \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "analysis_quota": 123,
  "asset_evaluation_quota": 123,
  "search_credits": 123,
  "logo": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "analysis_quota": 1073741823,
  "asset_evaluation_quota": 1073741823,
  "search_credits": 1073741823,
  "search_project_credits": 1073741823,
  "logo": "<string>",
  "is_pencil": true,
  "pencil_client_id": 0,
  "pencil_client_uuid": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this workspace.

​
organization_id
string<uuid>
required

A UUID string identifying the organization.

Query Parameters

If set to true, include the logo field in the response. Defaults to false.

Body

​
name
string
​
analysis_quota
integer
​
asset_evaluation_quota
integer
​
search_credits
integer
​
logo
string | null

Binary content of the logo encoded in base64 with appropriate header ex: data:image/png;base64,XXXXXX

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
name
string
required
Maximum string length: 255
​
analysis_quota
integer
Required range: 0 <= x <= 2147483647
​
asset_evaluation_quota
integer
Required range: 0 <= x <= 2147483647
​
search_credits
integer
Required range: 0 <= x <= 2147483647
​
search_project_credits
integer
Required range: 0 <= x <= 2147483647
​
is_pencil
boolean
​
pencil_client_id
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
pencil_client_uuid
string | null
Maximum string length: 64