Organizations
Update Organization
Update an organization’s details.
PATCH
/
organizations
/
{organization_id}
Update Organization
curl --request PATCH \
--url https://answeringagent.com/api/v1/organizations/{organization_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Updated Acme Corporation",
"description": "An updated description"
}
'import requests
url = "https://answeringagent.com/api/v1/organizations/{organization_id}"
payload = {
"name": "Updated Acme Corporation",
"description": "An updated description"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Updated Acme Corporation', description: 'An updated description'})
};
fetch('https://answeringagent.com/api/v1/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://answeringagent.com/api/v1/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' => 'Updated Acme Corporation',
'description' => 'An updated description'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://answeringagent.com/api/v1/organizations/{organization_id}"
payload := strings.NewReader("{\n \"name\": \"Updated Acme Corporation\",\n \"description\": \"An updated description\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://answeringagent.com/api/v1/organizations/{organization_id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Updated Acme Corporation\",\n \"description\": \"An updated description\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://answeringagent.com/api/v1/organizations/{organization_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Updated Acme Corporation\",\n \"description\": \"An updated description\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Acme Corporation",
"partner_type": "provisioned",
"permissions": {
"can_view_dashboard": true,
"can_manage_dashboard_viewers": true
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z",
"users": [
{
"id": 123,
"external_id": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"organizations": [
{
"id": 123,
"name": "<string>",
"role": "owner"
}
]
}
],
"phone_numbers": [
{
"id": 123,
"name": "<string>",
"phone_number": "<string>",
"status": "pending",
"address": "<string>",
"google_place_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "API key is required"
}{
"message": "Organization not found"
}{
"message": "<string>",
"errors": {}
}Body
application/json
Response
Organization updated successfully.
How this organization is attached to your partner account. 'provisioned' organizations were created through this API and can be updated or deleted. 'linked' organizations belong to existing Answering Agent accounts attached via an accepted partner link and are read-only.
Available options:
provisioned, linked Example:
"provisioned"
⌘I
Update Organization
curl --request PATCH \
--url https://answeringagent.com/api/v1/organizations/{organization_id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Updated Acme Corporation",
"description": "An updated description"
}
'import requests
url = "https://answeringagent.com/api/v1/organizations/{organization_id}"
payload = {
"name": "Updated Acme Corporation",
"description": "An updated description"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Updated Acme Corporation', description: 'An updated description'})
};
fetch('https://answeringagent.com/api/v1/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://answeringagent.com/api/v1/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' => 'Updated Acme Corporation',
'description' => 'An updated description'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://answeringagent.com/api/v1/organizations/{organization_id}"
payload := strings.NewReader("{\n \"name\": \"Updated Acme Corporation\",\n \"description\": \"An updated description\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://answeringagent.com/api/v1/organizations/{organization_id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Updated Acme Corporation\",\n \"description\": \"An updated description\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://answeringagent.com/api/v1/organizations/{organization_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Updated Acme Corporation\",\n \"description\": \"An updated description\"\n}"
response = http.request(request)
puts response.read_body{
"id": 1,
"name": "Acme Corporation",
"partner_type": "provisioned",
"permissions": {
"can_view_dashboard": true,
"can_manage_dashboard_viewers": true
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:45:00Z",
"users": [
{
"id": 123,
"external_id": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"organizations": [
{
"id": 123,
"name": "<string>",
"role": "owner"
}
]
}
],
"phone_numbers": [
{
"id": 123,
"name": "<string>",
"phone_number": "<string>",
"status": "pending",
"address": "<string>",
"google_place_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "API key is required"
}{
"message": "Organization not found"
}{
"message": "<string>",
"errors": {}
}