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,
  "geo_audit_quota": 1,
  "search_credits": 1,
  "logo": "<string>",
  "salesforce_code": "<string>",
  "contract_end_date": "2023-12-25",
  "is_active": true,
  "modules": []
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{id}"

payload = {
    "name": "<string>",
    "user_quota": 1,
    "workspace_quota": 1,
    "analysis_quota": 1,
    "asset_evaluation_quota": 1,
    "geo_audit_quota": 1,
    "search_credits": 1,
    "logo": "<string>",
    "salesforce_code": "<string>",
    "contract_end_date": "2023-12-25",
    "is_active": True,
    "modules": []
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    user_quota: 1,
    workspace_quota: 1,
    analysis_quota: 1,
    asset_evaluation_quota: 1,
    geo_audit_quota: 1,
    search_credits: 1,
    logo: '<string>',
    salesforce_code: '<string>',
    contract_end_date: '2023-12-25',
    is_active: true,
    modules: []
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shareofmodel.ai/v1/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'user_quota' => 1,
    'workspace_quota' => 1,
    'analysis_quota' => 1,
    'asset_evaluation_quota' => 1,
    'geo_audit_quota' => 1,
    'search_credits' => 1,
    'logo' => '<string>',
    'salesforce_code' => '<string>',
    'contract_end_date' => '2023-12-25',
    'is_active' => true,
    'modules' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shareofmodel.ai/v1/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"user_quota\": 1,\n  \"workspace_quota\": 1,\n  \"analysis_quota\": 1,\n  \"asset_evaluation_quota\": 1,\n  \"geo_audit_quota\": 1,\n  \"search_credits\": 1,\n  \"logo\": \"<string>\",\n  \"salesforce_code\": \"<string>\",\n  \"contract_end_date\": \"2023-12-25\",\n  \"is_active\": true,\n  \"modules\": []\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.shareofmodel.ai/v1/organizations/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"user_quota\": 1,\n  \"workspace_quota\": 1,\n  \"analysis_quota\": 1,\n  \"asset_evaluation_quota\": 1,\n  \"geo_audit_quota\": 1,\n  \"search_credits\": 1,\n  \"logo\": \"<string>\",\n  \"salesforce_code\": \"<string>\",\n  \"contract_end_date\": \"2023-12-25\",\n  \"is_active\": true,\n  \"modules\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"user_quota\": 1,\n  \"workspace_quota\": 1,\n  \"analysis_quota\": 1,\n  \"asset_evaluation_quota\": 1,\n  \"geo_audit_quota\": 1,\n  \"search_credits\": 1,\n  \"logo\": \"<string>\",\n  \"salesforce_code\": \"<string>\",\n  \"contract_end_date\": \"2023-12-25\",\n  \"is_active\": true,\n  \"modules\": []\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "geo_audit_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
}

PATCH

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,
  "geo_audit_quota": 1,
  "search_credits": 1,
  "logo": "<string>",
  "salesforce_code": "<string>",
  "contract_end_date": "2023-12-25",
  "is_active": true,
  "modules": []
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{id}"

payload = {
    "name": "<string>",
    "user_quota": 1,
    "workspace_quota": 1,
    "analysis_quota": 1,
    "asset_evaluation_quota": 1,
    "geo_audit_quota": 1,
    "search_credits": 1,
    "logo": "<string>",
    "salesforce_code": "<string>",
    "contract_end_date": "2023-12-25",
    "is_active": True,
    "modules": []
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    user_quota: 1,
    workspace_quota: 1,
    analysis_quota: 1,
    asset_evaluation_quota: 1,
    geo_audit_quota: 1,
    search_credits: 1,
    logo: '<string>',
    salesforce_code: '<string>',
    contract_end_date: '2023-12-25',
    is_active: true,
    modules: []
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shareofmodel.ai/v1/organizations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'user_quota' => 1,
    'workspace_quota' => 1,
    'analysis_quota' => 1,
    'asset_evaluation_quota' => 1,
    'geo_audit_quota' => 1,
    'search_credits' => 1,
    'logo' => '<string>',
    'salesforce_code' => '<string>',
    'contract_end_date' => '2023-12-25',
    'is_active' => true,
    'modules' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shareofmodel.ai/v1/organizations/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"user_quota\": 1,\n  \"workspace_quota\": 1,\n  \"analysis_quota\": 1,\n  \"asset_evaluation_quota\": 1,\n  \"geo_audit_quota\": 1,\n  \"search_credits\": 1,\n  \"logo\": \"<string>\",\n  \"salesforce_code\": \"<string>\",\n  \"contract_end_date\": \"2023-12-25\",\n  \"is_active\": true,\n  \"modules\": []\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.shareofmodel.ai/v1/organizations/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"user_quota\": 1,\n  \"workspace_quota\": 1,\n  \"analysis_quota\": 1,\n  \"asset_evaluation_quota\": 1,\n  \"geo_audit_quota\": 1,\n  \"search_credits\": 1,\n  \"logo\": \"<string>\",\n  \"salesforce_code\": \"<string>\",\n  \"contract_end_date\": \"2023-12-25\",\n  \"is_active\": true,\n  \"modules\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"user_quota\": 1,\n  \"workspace_quota\": 1,\n  \"analysis_quota\": 1,\n  \"asset_evaluation_quota\": 1,\n  \"geo_audit_quota\": 1,\n  \"search_credits\": 1,\n  \"logo\": \"<string>\",\n  \"salesforce_code\": \"<string>\",\n  \"contract_end_date\": \"2023-12-25\",\n  \"is_active\": true,\n  \"modules\": []\n}"

response = http.request(request)
puts response.read_body

{
  "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,
  "geo_audit_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

string<uuid>

required

A UUID string identifying this organization.

Query Parameters

include_logo

boolean

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

geo_audit_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

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

geo_audit_quota

integer

Required range: 0 <= x <= 2147483647

search_credits

integer

Required range: 0 <= x <= 2147483647

logo

string

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

Retrieve organization

Filter organizations

Overview

Core API

Search API

Update organization

Authorizations

Path Parameters

Query Parameters

Body

Response