Set a company's owning teammate
curl --request PUT \
--url http://localhost:8080/companies/{external_id}/owner \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": {
"id": 0,
"email": "[email protected]"
}
}
'import requests
url = "http://localhost:8080/companies/{external_id}/owner"
payload = { "owner": {
"id": 0,
"email": "[email protected]"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({owner: {id: 0, email: '[email protected]'}})
};
fetch('http://localhost:8080/companies/{external_id}/owner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/companies/{external_id}/owner",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'owner' => [
'id' => 0,
'email' => '[email protected]'
]
]),
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 := "http://localhost:8080/companies/{external_id}/owner"
payload := strings.NewReader("{\n \"owner\": {\n \"id\": 0,\n \"email\": \"[email protected]\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:8080/companies/{external_id}/owner")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"owner\": {\n \"id\": 0,\n \"email\": \"[email protected]\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/companies/{external_id}/owner")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"owner\": {\n \"id\": 0,\n \"email\": \"[email protected]\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"name": "<string>",
"custom_data": {},
"agent_owner": {
"id": 0,
"name": "<string>",
"email": "[email protected]"
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Companies
Set a company's owning teammate
Assign the teammate who owns a company account, naming them by OpenCX user id or by email, or clear the owner to leave the account unassigned.
PUT
/
companies
/
{external_id}
/
owner
Set a company's owning teammate
curl --request PUT \
--url http://localhost:8080/companies/{external_id}/owner \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"owner": {
"id": 0,
"email": "[email protected]"
}
}
'import requests
url = "http://localhost:8080/companies/{external_id}/owner"
payload = { "owner": {
"id": 0,
"email": "[email protected]"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({owner: {id: 0, email: '[email protected]'}})
};
fetch('http://localhost:8080/companies/{external_id}/owner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/companies/{external_id}/owner",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'owner' => [
'id' => 0,
'email' => '[email protected]'
]
]),
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 := "http://localhost:8080/companies/{external_id}/owner"
payload := strings.NewReader("{\n \"owner\": {\n \"id\": 0,\n \"email\": \"[email protected]\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:8080/companies/{external_id}/owner")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"owner\": {\n \"id\": 0,\n \"email\": \"[email protected]\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/companies/{external_id}/owner")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"owner\": {\n \"id\": 0,\n \"email\": \"[email protected]\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"name": "<string>",
"custom_data": {},
"agent_owner": {
"id": 0,
"name": "<string>",
"email": "[email protected]"
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Minimum string length:
1Body
application/json
The teammate who owns this account. Null leaves the company unowned.
Show child attributes
Show child attributes
Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$The organization's own key for this company
Show child attributes
Show child attributes
The teammate who owns this account. Null when nobody owns it, which is the ordinary state.
Show child attributes
Show child attributes
ISO 8601 timestamp of when the company was created
ISO 8601 timestamp of when the company was last updated
Was this page helpful?