Update an organization
curl --request PATCH \
--url https://api.ionworks.com/organizations/{organization_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"usage_limit": {},
"nav_config": {}
}
'import requests
url = "https://api.ionworks.com/organizations/{organization_id}"
payload = {
"name": "<string>",
"usage_limit": {},
"nav_config": {}
}
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>', usage_limit: {}, nav_config: {}})
};
fetch('https://api.ionworks.com/organizations/{organization_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.ionworks.com/organizations/{organization_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>',
'usage_limit' => [
],
'nav_config' => [
]
]),
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.ionworks.com/organizations/{organization_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"usage_limit\": {},\n \"nav_config\": {}\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.ionworks.com/organizations/{organization_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"usage_limit\": {},\n \"nav_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/organizations/{organization_id}")
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 \"usage_limit\": {},\n \"nav_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"usage_limit": {},
"nav_config": {},
"user_organization_roles": [
{
"organization_id": "<string>",
"user_id": "<string>",
"users": {
"id": "<string>",
"email": "<string>"
},
"organization_role_id": "<string>",
"organization_roles": {
"name": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"organization_role_permissions": [
{}
]
},
"deactivated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update an organization
Update an existing organization identified by its ID.
Only provided fields will be updated.
Update an organization
curl --request PATCH \
--url https://api.ionworks.com/organizations/{organization_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"usage_limit": {},
"nav_config": {}
}
'import requests
url = "https://api.ionworks.com/organizations/{organization_id}"
payload = {
"name": "<string>",
"usage_limit": {},
"nav_config": {}
}
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>', usage_limit: {}, nav_config: {}})
};
fetch('https://api.ionworks.com/organizations/{organization_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.ionworks.com/organizations/{organization_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>',
'usage_limit' => [
],
'nav_config' => [
]
]),
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.ionworks.com/organizations/{organization_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"usage_limit\": {},\n \"nav_config\": {}\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.ionworks.com/organizations/{organization_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"usage_limit\": {},\n \"nav_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/organizations/{organization_id}")
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 \"usage_limit\": {},\n \"nav_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"usage_limit": {},
"nav_config": {},
"user_organization_roles": [
{
"organization_id": "<string>",
"user_id": "<string>",
"users": {
"id": "<string>",
"email": "<string>"
},
"organization_role_id": "<string>",
"organization_roles": {
"name": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"organization_role_permissions": [
{}
]
},
"deactivated_at": "2023-11-07T05:31:56Z"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
application/json
Model for updating an existing organization. All fields are optional.
Response
Successful Response
Pydantic model for an organization.
Monthly usage limit
Show child attributes
Show child attributes
Per-organization nav config: { '': { 'show': bool, 'disabled': bool, 'badgeLabel': str | None, 'badgeTooltip': str | None } }
List of user organization roles
Show child attributes
Show child attributes
Timestamp of creation
Timestamp of last update
Was this page helpful?
⌘I