Skip to main content
PATCH
/
v1
/
organizations
/
{id}
Update organization
curl --request PATCH \
  --url https://api.shareofmodel.ai/v1/organizations/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "user_quota": 1,
  "workspace_quota": 1,
  "analysis_quota": 1,
  "asset_evaluation_quota": 1,
  "search_credits": 1,
  "logo": "<string>",
  "salesforce_code": "<string>",
  "contract_end_date": "2023-12-25",
  "is_active": true,
  "modules": []
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "user_quota": 1073741823,
  "workspace_quota": 1073741823,
  "analysis_quota": 1073741823,
  "workspace_count": 123,
  "modules": [
    "<string>"
  ],
  "asset_evaluation_quota": 1073741823,
  "search_credits": 1073741823,
  "logo": "<string>",
  "salesforce_code": "<string>",
  "contract_end_date": "2023-12-25",
  "is_active": true,
  "is_pencil": true,
  "pencil_customer_id": 0
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this organization.

Query Parameters

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

Body

​
name
string
​
plan
enum<string>
  • pilot - pilot
  • starter - starter
  • suite - suite
  • enterprise - enterprise
  • pencil - pencil
Available options:
pilot,
starter,
suite,
enterprise,
pencil
​
user_quota
integer
Required range: x >= 0
​
workspace_quota
integer
Required range: x >= 0
​
analysis_quota
integer
Required range: x >= 0
​
asset_evaluation_quota
integer
Required range: x >= 0
​
search_credits
integer
Required range: x >= 0
​
logo
string | null

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

​
salesforce_code
string | null
​
contract_end_date
string<date> | null
​
is_active
boolean
​
modules
enum<string>[]
Minimum array length: 1
  • Assets - Assets
  • Models - Models
  • Search - Search
  • Sources - Sources
  • Shopping - Shopping
  • Website - Website
  • Dashboard - Dashboard
  • Opportunity - Opportunity
  • Integration - Integration
Available options:
Assets,
Models,
Search,
Sources,
Shopping,
Website,
Dashboard,
Opportunity,
Integration

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
name
string
required
Maximum string length: 255
​
plan
enum<string>
required
  • pilot - pilot
  • starter - starter
  • suite - suite
  • enterprise - enterprise
  • pencil - pencil
Available options:
pilot,
starter,
suite,
enterprise,
pencil
​
user_quota
integer
required
Required range: 0 <= x <= 2147483647
​
workspace_quota
integer
required
Required range: 0 <= x <= 2147483647
​
analysis_quota
integer
required
Required range: 0 <= x <= 2147483647
​
workspace_count
integer
required
​
modules
string[]
required
read-only
​
asset_evaluation_quota
integer
Required range: 0 <= x <= 2147483647
​
search_credits
integer
Required range: 0 <= x <= 2147483647
​
salesforce_code
string | null

SalesForce organization code

Maximum string length: 50
​
contract_end_date
string<date> | null

Contract end date

​
is_active
boolean
​
is_pencil
boolean
​
pencil_customer_id
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000