Update organization
curl --request PATCH \
--url https://api.example.com/v1/org \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"allowedEmailDomains": [
"<string>"
],
"allowedDesktopVersions": [
"<string>"
],
"requireSso": true,
"brandAppName": "<string>",
"brandLogoUrl": "<string>",
"brandIconUrl": "<string>",
"brandAccentColor": "<string>"
}
'import requests
url = "https://api.example.com/v1/org"
payload = {
"name": "<string>",
"allowedEmailDomains": ["<string>"],
"allowedDesktopVersions": ["<string>"],
"requireSso": True,
"brandAppName": "<string>",
"brandLogoUrl": "<string>",
"brandIconUrl": "<string>",
"brandAccentColor": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
allowedEmailDomains: ['<string>'],
allowedDesktopVersions: ['<string>'],
requireSso: true,
brandAppName: '<string>',
brandLogoUrl: '<string>',
brandIconUrl: '<string>',
brandAccentColor: '<string>'
})
};
fetch('https://api.example.com/v1/org', 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.example.com/v1/org",
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>',
'allowedEmailDomains' => [
'<string>'
],
'allowedDesktopVersions' => [
'<string>'
],
'requireSso' => true,
'brandAppName' => '<string>',
'brandLogoUrl' => '<string>',
'brandIconUrl' => '<string>',
'brandAccentColor' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/org"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"allowedEmailDomains\": [\n \"<string>\"\n ],\n \"allowedDesktopVersions\": [\n \"<string>\"\n ],\n \"requireSso\": true,\n \"brandAppName\": \"<string>\",\n \"brandLogoUrl\": \"<string>\",\n \"brandIconUrl\": \"<string>\",\n \"brandAccentColor\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/v1/org")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"allowedEmailDomains\": [\n \"<string>\"\n ],\n \"allowedDesktopVersions\": [\n \"<string>\"\n ],\n \"requireSso\": true,\n \"brandAppName\": \"<string>\",\n \"brandLogoUrl\": \"<string>\",\n \"brandIconUrl\": \"<string>\",\n \"brandAccentColor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/org")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"allowedEmailDomains\": [\n \"<string>\"\n ],\n \"allowedDesktopVersions\": [\n \"<string>\"\n ],\n \"requireSso\": true,\n \"brandAppName\": \"<string>\",\n \"brandLogoUrl\": \"<string>\",\n \"brandIconUrl\": \"<string>\",\n \"brandAccentColor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"organization": {}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"feature": "<string>",
"message": "<string>"
}{
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Organizations
Update organization
Updates organization fields that workspace owners are allowed to change, including the display name, allowed invitation email domains, and allowed desktop versions. The slug is immutable to avoid breaking dashboard URLs.
PATCH
/
v1
/
org
Update organization
curl --request PATCH \
--url https://api.example.com/v1/org \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"allowedEmailDomains": [
"<string>"
],
"allowedDesktopVersions": [
"<string>"
],
"requireSso": true,
"brandAppName": "<string>",
"brandLogoUrl": "<string>",
"brandIconUrl": "<string>",
"brandAccentColor": "<string>"
}
'import requests
url = "https://api.example.com/v1/org"
payload = {
"name": "<string>",
"allowedEmailDomains": ["<string>"],
"allowedDesktopVersions": ["<string>"],
"requireSso": True,
"brandAppName": "<string>",
"brandLogoUrl": "<string>",
"brandIconUrl": "<string>",
"brandAccentColor": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
allowedEmailDomains: ['<string>'],
allowedDesktopVersions: ['<string>'],
requireSso: true,
brandAppName: '<string>',
brandLogoUrl: '<string>',
brandIconUrl: '<string>',
brandAccentColor: '<string>'
})
};
fetch('https://api.example.com/v1/org', 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.example.com/v1/org",
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>',
'allowedEmailDomains' => [
'<string>'
],
'allowedDesktopVersions' => [
'<string>'
],
'requireSso' => true,
'brandAppName' => '<string>',
'brandLogoUrl' => '<string>',
'brandIconUrl' => '<string>',
'brandAccentColor' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/org"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"allowedEmailDomains\": [\n \"<string>\"\n ],\n \"allowedDesktopVersions\": [\n \"<string>\"\n ],\n \"requireSso\": true,\n \"brandAppName\": \"<string>\",\n \"brandLogoUrl\": \"<string>\",\n \"brandIconUrl\": \"<string>\",\n \"brandAccentColor\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/v1/org")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"allowedEmailDomains\": [\n \"<string>\"\n ],\n \"allowedDesktopVersions\": [\n \"<string>\"\n ],\n \"requireSso\": true,\n \"brandAppName\": \"<string>\",\n \"brandLogoUrl\": \"<string>\",\n \"brandIconUrl\": \"<string>\",\n \"brandAccentColor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/org")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"allowedEmailDomains\": [\n \"<string>\"\n ],\n \"allowedDesktopVersions\": [\n \"<string>\"\n ],\n \"requireSso\": true,\n \"brandAppName\": \"<string>\",\n \"brandLogoUrl\": \"<string>\",\n \"brandIconUrl\": \"<string>\",\n \"brandAccentColor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"organization": {}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"feature": "<string>",
"message": "<string>"
}{
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Body
application/json
Required string length:
2 - 120Maximum array length:
100Required string length:
1 - 255Maximum array length:
200Required string length:
1 - 32Required string length:
1 - 64Maximum string length:
2048Maximum string length:
2048Required string length:
1 - 32Response
Organization updated successfully.
Show child attributes
Show child attributes
Was this page helpful?
⌘I