Organizations
Create Organization
Create a new organization with an owner. This is the recommended way to onboard new customers - create the organization first, then add additional users and locations as needed.
POST
/
organizations
Create Organization
curl --request POST \
--url https://answeringagent.com/api/v1/organizations \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Acme Corporation",
"owner": {
"external_id": "user_123",
"email": "john@acme.com",
"name": "John Doe"
},
"description": "A technology company specializing in innovative solutions"
}
'import requests
url = "https://answeringagent.com/api/v1/organizations"
payload = {
"name": "Acme Corporation",
"owner": {
"external_id": "user_123",
"email": "john@acme.com",
"name": "John Doe"
},
"description": "A technology company specializing in innovative solutions"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corporation',
owner: {external_id: 'user_123', email: 'john@acme.com', name: 'John Doe'},
description: 'A technology company specializing in innovative solutions'
})
};
fetch('https://answeringagent.com/api/v1/organizations', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Corporation',
'owner' => [
'external_id' => 'user_123',
'email' => 'john@acme.com',
'name' => 'John Doe'
],
'description' => 'A technology company specializing in innovative solutions'
]),
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"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"owner\": {\n \"external_id\": \"user_123\",\n \"email\": \"john@acme.com\",\n \"name\": \"John Doe\"\n },\n \"description\": \"A technology company specializing in innovative solutions\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://answeringagent.com/api/v1/organizations")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"owner\": {\n \"external_id\": \"user_123\",\n \"email\": \"john@acme.com\",\n \"name\": \"John Doe\"\n },\n \"description\": \"A technology company specializing in innovative solutions\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://answeringagent.com/api/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"owner\": {\n \"external_id\": \"user_123\",\n \"email\": \"john@acme.com\",\n \"name\": \"John Doe\"\n },\n \"description\": \"A technology company specializing in innovative solutions\"\n}"
response = http.request(request)
puts response.read_body{
"organization": {
"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>"
}
]
}
],
"phone_numbers": [
{
"id": 123,
"name": "<string>",
"phone_number": "<string>",
"address": "<string>",
"google_place_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
},
"owner": {
"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>"
}
]
}
}{
"error": "API key is required"
}{
"message": "<string>",
"errors": {}
}Authorizations
Body
application/json
⌘I
Create Organization
curl --request POST \
--url https://answeringagent.com/api/v1/organizations \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Acme Corporation",
"owner": {
"external_id": "user_123",
"email": "john@acme.com",
"name": "John Doe"
},
"description": "A technology company specializing in innovative solutions"
}
'import requests
url = "https://answeringagent.com/api/v1/organizations"
payload = {
"name": "Acme Corporation",
"owner": {
"external_id": "user_123",
"email": "john@acme.com",
"name": "John Doe"
},
"description": "A technology company specializing in innovative solutions"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Acme Corporation',
owner: {external_id: 'user_123', email: 'john@acme.com', name: 'John Doe'},
description: 'A technology company specializing in innovative solutions'
})
};
fetch('https://answeringagent.com/api/v1/organizations', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Acme Corporation',
'owner' => [
'external_id' => 'user_123',
'email' => 'john@acme.com',
'name' => 'John Doe'
],
'description' => 'A technology company specializing in innovative solutions'
]),
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"
payload := strings.NewReader("{\n \"name\": \"Acme Corporation\",\n \"owner\": {\n \"external_id\": \"user_123\",\n \"email\": \"john@acme.com\",\n \"name\": \"John Doe\"\n },\n \"description\": \"A technology company specializing in innovative solutions\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://answeringagent.com/api/v1/organizations")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Corporation\",\n \"owner\": {\n \"external_id\": \"user_123\",\n \"email\": \"john@acme.com\",\n \"name\": \"John Doe\"\n },\n \"description\": \"A technology company specializing in innovative solutions\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://answeringagent.com/api/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Corporation\",\n \"owner\": {\n \"external_id\": \"user_123\",\n \"email\": \"john@acme.com\",\n \"name\": \"John Doe\"\n },\n \"description\": \"A technology company specializing in innovative solutions\"\n}"
response = http.request(request)
puts response.read_body{
"organization": {
"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>"
}
]
}
],
"phone_numbers": [
{
"id": 123,
"name": "<string>",
"phone_number": "<string>",
"address": "<string>",
"google_place_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
},
"owner": {
"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>"
}
]
}
}{
"error": "API key is required"
}{
"message": "<string>",
"errors": {}
}