Update company information.
curl --request PATCH \
--url https://api.example.com/api/v0/companies/{company_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"about": "<string>",
"legalName": "<string>",
"legalAddress": "<string>",
"legalCountry": "<string>",
"logo": "<string>",
"website": "<string>",
"github": "<string>",
"twitter": "<string>",
"domain": "<string>",
"autoJoinAllowed": true,
"showAuditLog": true,
"adminData": "<unknown>",
"mergeWith": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"sessionSettings": {
"maxTime": 123,
"refreshTime": 123
}
}
'import requests
url = "https://api.example.com/api/v0/companies/{company_id}"
payload = {
"name": "<string>",
"handle": "<string>",
"about": "<string>",
"legalName": "<string>",
"legalAddress": "<string>",
"legalCountry": "<string>",
"logo": "<string>",
"website": "<string>",
"github": "<string>",
"twitter": "<string>",
"domain": "<string>",
"autoJoinAllowed": True,
"showAuditLog": True,
"adminData": "<unknown>",
"mergeWith": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"sessionSettings": {
"maxTime": 123,
"refreshTime": 123
}
}
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>',
handle: '<string>',
about: '<string>',
legalName: '<string>',
legalAddress: '<string>',
legalCountry: '<string>',
logo: '<string>',
website: '<string>',
github: '<string>',
twitter: '<string>',
domain: '<string>',
autoJoinAllowed: true,
showAuditLog: true,
adminData: '<unknown>',
mergeWith: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
sessionSettings: {maxTime: 123, refreshTime: 123}
})
};
fetch('https://api.example.com/api/v0/companies/{company_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.example.com/api/v0/companies/{company_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>',
'handle' => '<string>',
'about' => '<string>',
'legalName' => '<string>',
'legalAddress' => '<string>',
'legalCountry' => '<string>',
'logo' => '<string>',
'website' => '<string>',
'github' => '<string>',
'twitter' => '<string>',
'domain' => '<string>',
'autoJoinAllowed' => true,
'showAuditLog' => true,
'adminData' => '<unknown>',
'mergeWith' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'sessionSettings' => [
'maxTime' => 123,
'refreshTime' => 123
]
]),
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/api/v0/companies/{company_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"about\": \"<string>\",\n \"legalName\": \"<string>\",\n \"legalAddress\": \"<string>\",\n \"legalCountry\": \"<string>\",\n \"logo\": \"<string>\",\n \"website\": \"<string>\",\n \"github\": \"<string>\",\n \"twitter\": \"<string>\",\n \"domain\": \"<string>\",\n \"autoJoinAllowed\": true,\n \"showAuditLog\": true,\n \"adminData\": \"<unknown>\",\n \"mergeWith\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"sessionSettings\": {\n \"maxTime\": 123,\n \"refreshTime\": 123\n }\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/api/v0/companies/{company_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"about\": \"<string>\",\n \"legalName\": \"<string>\",\n \"legalAddress\": \"<string>\",\n \"legalCountry\": \"<string>\",\n \"logo\": \"<string>\",\n \"website\": \"<string>\",\n \"github\": \"<string>\",\n \"twitter\": \"<string>\",\n \"domain\": \"<string>\",\n \"autoJoinAllowed\": true,\n \"showAuditLog\": true,\n \"adminData\": \"<unknown>\",\n \"mergeWith\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"sessionSettings\": {\n \"maxTime\": 123,\n \"refreshTime\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/companies/{company_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 \"handle\": \"<string>\",\n \"about\": \"<string>\",\n \"legalName\": \"<string>\",\n \"legalAddress\": \"<string>\",\n \"legalCountry\": \"<string>\",\n \"logo\": \"<string>\",\n \"website\": \"<string>\",\n \"github\": \"<string>\",\n \"twitter\": \"<string>\",\n \"domain\": \"<string>\",\n \"autoJoinAllowed\": true,\n \"showAuditLog\": true,\n \"adminData\": \"<unknown>\",\n \"mergeWith\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"sessionSettings\": {\n \"maxTime\": 123,\n \"refreshTime\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}Companies
Update company information.
Access Control Rules
- Company manager of the company.
- Admins can list all companies. Requires
manage_companiespermissions.
PATCH
/
api
/
v0
/
companies
/
{company_id}
Update company information.
curl --request PATCH \
--url https://api.example.com/api/v0/companies/{company_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"about": "<string>",
"legalName": "<string>",
"legalAddress": "<string>",
"legalCountry": "<string>",
"logo": "<string>",
"website": "<string>",
"github": "<string>",
"twitter": "<string>",
"domain": "<string>",
"autoJoinAllowed": true,
"showAuditLog": true,
"adminData": "<unknown>",
"mergeWith": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"sessionSettings": {
"maxTime": 123,
"refreshTime": 123
}
}
'import requests
url = "https://api.example.com/api/v0/companies/{company_id}"
payload = {
"name": "<string>",
"handle": "<string>",
"about": "<string>",
"legalName": "<string>",
"legalAddress": "<string>",
"legalCountry": "<string>",
"logo": "<string>",
"website": "<string>",
"github": "<string>",
"twitter": "<string>",
"domain": "<string>",
"autoJoinAllowed": True,
"showAuditLog": True,
"adminData": "<unknown>",
"mergeWith": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"sessionSettings": {
"maxTime": 123,
"refreshTime": 123
}
}
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>',
handle: '<string>',
about: '<string>',
legalName: '<string>',
legalAddress: '<string>',
legalCountry: '<string>',
logo: '<string>',
website: '<string>',
github: '<string>',
twitter: '<string>',
domain: '<string>',
autoJoinAllowed: true,
showAuditLog: true,
adminData: '<unknown>',
mergeWith: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
sessionSettings: {maxTime: 123, refreshTime: 123}
})
};
fetch('https://api.example.com/api/v0/companies/{company_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.example.com/api/v0/companies/{company_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>',
'handle' => '<string>',
'about' => '<string>',
'legalName' => '<string>',
'legalAddress' => '<string>',
'legalCountry' => '<string>',
'logo' => '<string>',
'website' => '<string>',
'github' => '<string>',
'twitter' => '<string>',
'domain' => '<string>',
'autoJoinAllowed' => true,
'showAuditLog' => true,
'adminData' => '<unknown>',
'mergeWith' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'sessionSettings' => [
'maxTime' => 123,
'refreshTime' => 123
]
]),
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/api/v0/companies/{company_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"about\": \"<string>\",\n \"legalName\": \"<string>\",\n \"legalAddress\": \"<string>\",\n \"legalCountry\": \"<string>\",\n \"logo\": \"<string>\",\n \"website\": \"<string>\",\n \"github\": \"<string>\",\n \"twitter\": \"<string>\",\n \"domain\": \"<string>\",\n \"autoJoinAllowed\": true,\n \"showAuditLog\": true,\n \"adminData\": \"<unknown>\",\n \"mergeWith\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"sessionSettings\": {\n \"maxTime\": 123,\n \"refreshTime\": 123\n }\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/api/v0/companies/{company_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"about\": \"<string>\",\n \"legalName\": \"<string>\",\n \"legalAddress\": \"<string>\",\n \"legalCountry\": \"<string>\",\n \"logo\": \"<string>\",\n \"website\": \"<string>\",\n \"github\": \"<string>\",\n \"twitter\": \"<string>\",\n \"domain\": \"<string>\",\n \"autoJoinAllowed\": true,\n \"showAuditLog\": true,\n \"adminData\": \"<unknown>\",\n \"mergeWith\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"sessionSettings\": {\n \"maxTime\": 123,\n \"refreshTime\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/companies/{company_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 \"handle\": \"<string>\",\n \"about\": \"<string>\",\n \"legalName\": \"<string>\",\n \"legalAddress\": \"<string>\",\n \"legalCountry\": \"<string>\",\n \"logo\": \"<string>\",\n \"website\": \"<string>\",\n \"github\": \"<string>\",\n \"twitter\": \"<string>\",\n \"domain\": \"<string>\",\n \"autoJoinAllowed\": true,\n \"showAuditLog\": true,\n \"adminData\": \"<unknown>\",\n \"mergeWith\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"sessionSettings\": {\n \"maxTime\": 123,\n \"refreshTime\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}Path Parameters
Body
application/json
Admin only.
Setting this value when domain is not set has no effect.
Can only be set by admins.
Can only be set by admins.
The list of company ids to merge into the target company.
Session expiration settings
They are expressed in i64 seconds to be database-friendly.
Show child attributes
Show child attributes
Response
Company details successfully updated
⌘I