Orgs Orgs
Update Sub-Organization
Updates a sub-organization from the parent. Accepts a partial config (deep-merged server-side, includes modules visibility toggles) and an optional logo_id. Feature flags are not writable from this endpoint.
PATCH
/
orgs
/
{org_id}
/
orgs
/
{sub_org_id}
Update Sub-Organization
curl --request PATCH \
--url https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"logo_id": "<string>",
"config": {
"email": "jsmith@example.com",
"address": "<string>",
"terms_url": "<string>",
"privacy_url": "<string>",
"access": {
"session_ttl_seconds": 0,
"allow_google": true,
"allow_microsoft": true,
"allow_email_code": true,
"allow_invites": true
},
"modules": {
"enable_inbox": true,
"enable_analytics": true,
"enable_assistants": true,
"enable_knowledge_base": true,
"enable_broadcasts": true,
"enable_workflows": true,
"enable_audience": true,
"enable_tables": true,
"enable_pages": true,
"enable_balance_credits": true
}
},
"features": {
"allow_overdraft": true,
"workflows": true,
"enable_japifon": true
}
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}"
payload = {
"name": "<string>",
"logo_id": "<string>",
"config": {
"email": "jsmith@example.com",
"address": "<string>",
"terms_url": "<string>",
"privacy_url": "<string>",
"access": {
"session_ttl_seconds": 0,
"allow_google": True,
"allow_microsoft": True,
"allow_email_code": True,
"allow_invites": True
},
"modules": {
"enable_inbox": True,
"enable_analytics": True,
"enable_assistants": True,
"enable_knowledge_base": True,
"enable_broadcasts": True,
"enable_workflows": True,
"enable_audience": True,
"enable_tables": True,
"enable_pages": True,
"enable_balance_credits": True
}
},
"features": {
"allow_overdraft": True,
"workflows": True,
"enable_japifon": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
logo_id: '<string>',
config: {
email: 'jsmith@example.com',
address: '<string>',
terms_url: '<string>',
privacy_url: '<string>',
access: {
session_ttl_seconds: 0,
allow_google: true,
allow_microsoft: true,
allow_email_code: true,
allow_invites: true
},
modules: {
enable_inbox: true,
enable_analytics: true,
enable_assistants: true,
enable_knowledge_base: true,
enable_broadcasts: true,
enable_workflows: true,
enable_audience: true,
enable_tables: true,
enable_pages: true,
enable_balance_credits: true
}
},
features: {allow_overdraft: true, workflows: true, enable_japifon: true}
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_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.useinvent.com/orgs/{org_id}/orgs/{sub_org_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>',
'logo_id' => '<string>',
'config' => [
'email' => 'jsmith@example.com',
'address' => '<string>',
'terms_url' => '<string>',
'privacy_url' => '<string>',
'access' => [
'session_ttl_seconds' => 0,
'allow_google' => true,
'allow_microsoft' => true,
'allow_email_code' => true,
'allow_invites' => true
],
'modules' => [
'enable_inbox' => true,
'enable_analytics' => true,
'enable_assistants' => true,
'enable_knowledge_base' => true,
'enable_broadcasts' => true,
'enable_workflows' => true,
'enable_audience' => true,
'enable_tables' => true,
'enable_pages' => true,
'enable_balance_credits' => true
]
],
'features' => [
'allow_overdraft' => true,
'workflows' => true,
'enable_japifon' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"logo_id\": \"<string>\",\n \"config\": {\n \"email\": \"jsmith@example.com\",\n \"address\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"privacy_url\": \"<string>\",\n \"access\": {\n \"session_ttl_seconds\": 0,\n \"allow_google\": true,\n \"allow_microsoft\": true,\n \"allow_email_code\": true,\n \"allow_invites\": true\n },\n \"modules\": {\n \"enable_inbox\": true,\n \"enable_analytics\": true,\n \"enable_assistants\": true,\n \"enable_knowledge_base\": true,\n \"enable_broadcasts\": true,\n \"enable_workflows\": true,\n \"enable_audience\": true,\n \"enable_tables\": true,\n \"enable_pages\": true,\n \"enable_balance_credits\": true\n }\n },\n \"features\": {\n \"allow_overdraft\": true,\n \"workflows\": true,\n \"enable_japifon\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"logo_id\": \"<string>\",\n \"config\": {\n \"email\": \"jsmith@example.com\",\n \"address\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"privacy_url\": \"<string>\",\n \"access\": {\n \"session_ttl_seconds\": 0,\n \"allow_google\": true,\n \"allow_microsoft\": true,\n \"allow_email_code\": true,\n \"allow_invites\": true\n },\n \"modules\": {\n \"enable_inbox\": true,\n \"enable_analytics\": true,\n \"enable_assistants\": true,\n \"enable_knowledge_base\": true,\n \"enable_broadcasts\": true,\n \"enable_workflows\": true,\n \"enable_audience\": true,\n \"enable_tables\": true,\n \"enable_pages\": true,\n \"enable_balance_credits\": true\n }\n },\n \"features\": {\n \"allow_overdraft\": true,\n \"workflows\": true,\n \"enable_japifon\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"logo_id\": \"<string>\",\n \"config\": {\n \"email\": \"jsmith@example.com\",\n \"address\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"privacy_url\": \"<string>\",\n \"access\": {\n \"session_ttl_seconds\": 0,\n \"allow_google\": true,\n \"allow_microsoft\": true,\n \"allow_email_code\": true,\n \"allow_invites\": true\n },\n \"modules\": {\n \"enable_inbox\": true,\n \"enable_analytics\": true,\n \"enable_assistants\": true,\n \"enable_knowledge_base\": true,\n \"enable_broadcasts\": true,\n \"enable_workflows\": true,\n \"enable_audience\": true,\n \"enable_tables\": true,\n \"enable_pages\": true,\n \"enable_balance_credits\": true\n }\n },\n \"features\": {\n \"allow_overdraft\": true,\n \"workflows\": true,\n \"enable_japifon\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"logo_url": "<string>",
"balance": 123,
"promo_balance": 123,
"billing": {
"auto_recharge": {
"enabled": true,
"recharge_threshold": 252.5,
"recharge_amount": 252.5
},
"use_parent_balance": true,
"spending_cap": {
"enabled": true,
"amount": 50000,
"reset_at": "2023-11-07T05:31:56Z"
},
"payment_method": {
"type": "<string>",
"payment_method_id": "<string>",
"brand": "<string>",
"last4": "<string>",
"inactive": true,
"failed_at": "2023-11-07T05:31:56Z",
"failed_message": "<string>"
},
"last_low_balance_notification_at": "2023-11-07T05:31:56Z",
"last_out_of_balance_notification_at": "2023-11-07T05:31:56Z",
"last_spending_cap_notification_at": "2023-11-07T05:31:56Z"
},
"members": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"avatar": "<string>",
"org_id": "<string>",
"user_id": "<string>",
"preferences": {
"notifications": {
"assigned_to_me": {
"enabled": true,
"notified_at": "2023-11-07T05:31:56Z"
},
"billing": {
"enabled": true,
"notified_at": "2023-11-07T05:31:56Z"
}
},
"canned_responses": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"name": "<string>"
}
]
},
"roles": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"permissions": []
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"seen_at": "2023-11-07T05:31:56Z"
}
],
"spending_cap_used": 123,
"created_at": "2023-11-07T05:31:56Z",
"features": {
"enterprise": true,
"allow_overdraft": true,
"workflows": true,
"enable_japifon": true,
"slack_access": true,
"emails": true,
"templates": true,
"org_chats": true
},
"config": {
"email": "jsmith@example.com",
"address": "<string>",
"terms_url": "<string>",
"privacy_url": "<string>",
"access": {
"session_ttl_seconds": 0,
"allow_google": true,
"allow_microsoft": true,
"allow_email_code": true,
"allow_invites": true
},
"modules": {
"enable_inbox": true,
"enable_analytics": true,
"enable_assistants": true,
"enable_knowledge_base": true,
"enable_broadcasts": true,
"enable_workflows": true,
"enable_audience": true,
"enable_tables": true,
"enable_pages": true,
"enable_balance_credits": true
}
}
}Authorizations
Bearer token authentication using your API key
Path Parameters
The ID of the parent organization
The ID of the sub-organization
Body
application/jsonmultipart/form-data
Schema for updating a sub-organization from the parent. Accepts an optional name, a partial config (deep-merged on the server), an optional logo_id, and a deprecated features field that is ignored.
Required string length:
2 - 64Logo file id; pass null to clear
Maximum string length:
128Organization configuration settings
Show child attributes
Show child attributes
[Deprecated] Legacy feature-delegation field. Ignored by the server; kept for backward compatibility. Feature flags are now managed exclusively by platform admins.
Show child attributes
Show child attributes
Response
200 - application/json
The updated sub-organization.
Summary information about a sub-organization
Unique identifier of the sub-organization
Name of the sub-organization
URL of the sub-organization logo
Type of subscription plan
Available options:
free, business Current credit balance
Current promotional credit balance
Schema for updating payment configuration
Show child attributes
Show child attributes
Members of the sub-organization
Show child attributes
Show child attributes
Amount spent in the current month
Timestamp when the sub-organization was created
Org gate-keeping features configuration
Show child attributes
Show child attributes
Organization configuration settings
Show child attributes
Show child attributes
Was this page helpful?
Previous
Join Sub-OrganizationAdds the authenticated parent org admin as a member of the specified sub-organization with the given role.
Next
⌘I
Update Sub-Organization
curl --request PATCH \
--url https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"logo_id": "<string>",
"config": {
"email": "jsmith@example.com",
"address": "<string>",
"terms_url": "<string>",
"privacy_url": "<string>",
"access": {
"session_ttl_seconds": 0,
"allow_google": true,
"allow_microsoft": true,
"allow_email_code": true,
"allow_invites": true
},
"modules": {
"enable_inbox": true,
"enable_analytics": true,
"enable_assistants": true,
"enable_knowledge_base": true,
"enable_broadcasts": true,
"enable_workflows": true,
"enable_audience": true,
"enable_tables": true,
"enable_pages": true,
"enable_balance_credits": true
}
},
"features": {
"allow_overdraft": true,
"workflows": true,
"enable_japifon": true
}
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}"
payload = {
"name": "<string>",
"logo_id": "<string>",
"config": {
"email": "jsmith@example.com",
"address": "<string>",
"terms_url": "<string>",
"privacy_url": "<string>",
"access": {
"session_ttl_seconds": 0,
"allow_google": True,
"allow_microsoft": True,
"allow_email_code": True,
"allow_invites": True
},
"modules": {
"enable_inbox": True,
"enable_analytics": True,
"enable_assistants": True,
"enable_knowledge_base": True,
"enable_broadcasts": True,
"enable_workflows": True,
"enable_audience": True,
"enable_tables": True,
"enable_pages": True,
"enable_balance_credits": True
}
},
"features": {
"allow_overdraft": True,
"workflows": True,
"enable_japifon": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
logo_id: '<string>',
config: {
email: 'jsmith@example.com',
address: '<string>',
terms_url: '<string>',
privacy_url: '<string>',
access: {
session_ttl_seconds: 0,
allow_google: true,
allow_microsoft: true,
allow_email_code: true,
allow_invites: true
},
modules: {
enable_inbox: true,
enable_analytics: true,
enable_assistants: true,
enable_knowledge_base: true,
enable_broadcasts: true,
enable_workflows: true,
enable_audience: true,
enable_tables: true,
enable_pages: true,
enable_balance_credits: true
}
},
features: {allow_overdraft: true, workflows: true, enable_japifon: true}
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_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.useinvent.com/orgs/{org_id}/orgs/{sub_org_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>',
'logo_id' => '<string>',
'config' => [
'email' => 'jsmith@example.com',
'address' => '<string>',
'terms_url' => '<string>',
'privacy_url' => '<string>',
'access' => [
'session_ttl_seconds' => 0,
'allow_google' => true,
'allow_microsoft' => true,
'allow_email_code' => true,
'allow_invites' => true
],
'modules' => [
'enable_inbox' => true,
'enable_analytics' => true,
'enable_assistants' => true,
'enable_knowledge_base' => true,
'enable_broadcasts' => true,
'enable_workflows' => true,
'enable_audience' => true,
'enable_tables' => true,
'enable_pages' => true,
'enable_balance_credits' => true
]
],
'features' => [
'allow_overdraft' => true,
'workflows' => true,
'enable_japifon' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"logo_id\": \"<string>\",\n \"config\": {\n \"email\": \"jsmith@example.com\",\n \"address\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"privacy_url\": \"<string>\",\n \"access\": {\n \"session_ttl_seconds\": 0,\n \"allow_google\": true,\n \"allow_microsoft\": true,\n \"allow_email_code\": true,\n \"allow_invites\": true\n },\n \"modules\": {\n \"enable_inbox\": true,\n \"enable_analytics\": true,\n \"enable_assistants\": true,\n \"enable_knowledge_base\": true,\n \"enable_broadcasts\": true,\n \"enable_workflows\": true,\n \"enable_audience\": true,\n \"enable_tables\": true,\n \"enable_pages\": true,\n \"enable_balance_credits\": true\n }\n },\n \"features\": {\n \"allow_overdraft\": true,\n \"workflows\": true,\n \"enable_japifon\": true\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"logo_id\": \"<string>\",\n \"config\": {\n \"email\": \"jsmith@example.com\",\n \"address\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"privacy_url\": \"<string>\",\n \"access\": {\n \"session_ttl_seconds\": 0,\n \"allow_google\": true,\n \"allow_microsoft\": true,\n \"allow_email_code\": true,\n \"allow_invites\": true\n },\n \"modules\": {\n \"enable_inbox\": true,\n \"enable_analytics\": true,\n \"enable_assistants\": true,\n \"enable_knowledge_base\": true,\n \"enable_broadcasts\": true,\n \"enable_workflows\": true,\n \"enable_audience\": true,\n \"enable_tables\": true,\n \"enable_pages\": true,\n \"enable_balance_credits\": true\n }\n },\n \"features\": {\n \"allow_overdraft\": true,\n \"workflows\": true,\n \"enable_japifon\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/orgs/{sub_org_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"logo_id\": \"<string>\",\n \"config\": {\n \"email\": \"jsmith@example.com\",\n \"address\": \"<string>\",\n \"terms_url\": \"<string>\",\n \"privacy_url\": \"<string>\",\n \"access\": {\n \"session_ttl_seconds\": 0,\n \"allow_google\": true,\n \"allow_microsoft\": true,\n \"allow_email_code\": true,\n \"allow_invites\": true\n },\n \"modules\": {\n \"enable_inbox\": true,\n \"enable_analytics\": true,\n \"enable_assistants\": true,\n \"enable_knowledge_base\": true,\n \"enable_broadcasts\": true,\n \"enable_workflows\": true,\n \"enable_audience\": true,\n \"enable_tables\": true,\n \"enable_pages\": true,\n \"enable_balance_credits\": true\n }\n },\n \"features\": {\n \"allow_overdraft\": true,\n \"workflows\": true,\n \"enable_japifon\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"logo_url": "<string>",
"balance": 123,
"promo_balance": 123,
"billing": {
"auto_recharge": {
"enabled": true,
"recharge_threshold": 252.5,
"recharge_amount": 252.5
},
"use_parent_balance": true,
"spending_cap": {
"enabled": true,
"amount": 50000,
"reset_at": "2023-11-07T05:31:56Z"
},
"payment_method": {
"type": "<string>",
"payment_method_id": "<string>",
"brand": "<string>",
"last4": "<string>",
"inactive": true,
"failed_at": "2023-11-07T05:31:56Z",
"failed_message": "<string>"
},
"last_low_balance_notification_at": "2023-11-07T05:31:56Z",
"last_out_of_balance_notification_at": "2023-11-07T05:31:56Z",
"last_spending_cap_notification_at": "2023-11-07T05:31:56Z"
},
"members": [
{
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"avatar": "<string>",
"org_id": "<string>",
"user_id": "<string>",
"preferences": {
"notifications": {
"assigned_to_me": {
"enabled": true,
"notified_at": "2023-11-07T05:31:56Z"
},
"billing": {
"enabled": true,
"notified_at": "2023-11-07T05:31:56Z"
}
},
"canned_responses": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"name": "<string>"
}
]
},
"roles": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"permissions": []
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"seen_at": "2023-11-07T05:31:56Z"
}
],
"spending_cap_used": 123,
"created_at": "2023-11-07T05:31:56Z",
"features": {
"enterprise": true,
"allow_overdraft": true,
"workflows": true,
"enable_japifon": true,
"slack_access": true,
"emails": true,
"templates": true,
"org_chats": true
},
"config": {
"email": "jsmith@example.com",
"address": "<string>",
"terms_url": "<string>",
"privacy_url": "<string>",
"access": {
"session_ttl_seconds": 0,
"allow_google": true,
"allow_microsoft": true,
"allow_email_code": true,
"allow_invites": true
},
"modules": {
"enable_inbox": true,
"enable_analytics": true,
"enable_assistants": true,
"enable_knowledge_base": true,
"enable_broadcasts": true,
"enable_workflows": true,
"enable_audience": true,
"enable_tables": true,
"enable_pages": true,
"enable_balance_credits": true
}
}
}