Create a company
curl --request POST \
--url https://api.assembly.com/v1/companies \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Acme Inc.",
"customFields": {},
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://example.com/icon.png",
"isPlaceholder": false
}
'import requests
url = "https://api.assembly.com/v1/companies"
payload = {
"name": "Acme Inc.",
"customFields": {},
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://example.com/icon.png",
"isPlaceholder": False
}
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 Inc.',
customFields: {},
fallbackColor: '#4F46E5',
iconImageUrl: 'https://example.com/icon.png',
isPlaceholder: false
})
};
fetch('https://api.assembly.com/v1/companies', 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.assembly.com/v1/companies",
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 Inc.',
'customFields' => [
],
'fallbackColor' => '#4F46E5',
'iconImageUrl' => 'https://example.com/icon.png',
'isPlaceholder' => false
]),
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://api.assembly.com/v1/companies"
payload := strings.NewReader("{\n \"name\": \"Acme Inc.\",\n \"customFields\": {},\n \"fallbackColor\": \"#4F46E5\",\n \"iconImageUrl\": \"https://example.com/icon.png\",\n \"isPlaceholder\": false\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://api.assembly.com/v1/companies")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Inc.\",\n \"customFields\": {},\n \"fallbackColor\": \"#4F46E5\",\n \"iconImageUrl\": \"https://example.com/icon.png\",\n \"isPlaceholder\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/companies")
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 Inc.\",\n \"customFields\": {},\n \"fallbackColor\": \"#4F46E5\",\n \"iconImageUrl\": \"https://example.com/icon.png\",\n \"isPlaceholder\": false\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2024-01-15T09:30:00Z",
"customFields": {},
"deleted": true,
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://portal.example.com/icons/acme.png",
"id": "550e8400-e29b-41d4-a716-446655440000",
"isPlaceholder": false,
"name": "Acme Inc",
"object": "client",
"updatedAt": "2024-02-20T14:05:00Z"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Companies
Create a company
Creates a company. Requires a name; fallbackColor, iconImageUrl, and customFields are optional.
POST
/
v1
/
companies
Create a company
curl --request POST \
--url https://api.assembly.com/v1/companies \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Acme Inc.",
"customFields": {},
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://example.com/icon.png",
"isPlaceholder": false
}
'import requests
url = "https://api.assembly.com/v1/companies"
payload = {
"name": "Acme Inc.",
"customFields": {},
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://example.com/icon.png",
"isPlaceholder": False
}
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 Inc.',
customFields: {},
fallbackColor: '#4F46E5',
iconImageUrl: 'https://example.com/icon.png',
isPlaceholder: false
})
};
fetch('https://api.assembly.com/v1/companies', 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.assembly.com/v1/companies",
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 Inc.',
'customFields' => [
],
'fallbackColor' => '#4F46E5',
'iconImageUrl' => 'https://example.com/icon.png',
'isPlaceholder' => false
]),
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://api.assembly.com/v1/companies"
payload := strings.NewReader("{\n \"name\": \"Acme Inc.\",\n \"customFields\": {},\n \"fallbackColor\": \"#4F46E5\",\n \"iconImageUrl\": \"https://example.com/icon.png\",\n \"isPlaceholder\": false\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://api.assembly.com/v1/companies")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Inc.\",\n \"customFields\": {},\n \"fallbackColor\": \"#4F46E5\",\n \"iconImageUrl\": \"https://example.com/icon.png\",\n \"isPlaceholder\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/companies")
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 Inc.\",\n \"customFields\": {},\n \"fallbackColor\": \"#4F46E5\",\n \"iconImageUrl\": \"https://example.com/icon.png\",\n \"isPlaceholder\": false\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2024-01-15T09:30:00Z",
"customFields": {},
"deleted": true,
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://portal.example.com/icons/acme.png",
"id": "550e8400-e29b-41d4-a716-446655440000",
"isPlaceholder": false,
"name": "Acme Inc",
"object": "client",
"updatedAt": "2024-02-20T14:05:00Z"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Authorizations
Body
application/json
Company to create
Name is the company's display name.
Example:
"Acme Inc."
CustomFields holds custom field values keyed by custom field key.
Show child attributes
Show child attributes
FallbackColor is the hex color used as the icon background when no image is set.
Example:
"#4F46E5"
IconImageUrl is the URL of the company's icon image. Images hosted outside Assembly are copied into Assembly storage and the stored URL is replaced with the copy.
Example:
"https://example.com/icon.png"
IsPlaceholder marks the company as a placeholder record.
Example:
false
Response
OK
Created is the RFC 3339 timestamp at which the object was created.
Example:
"2024-01-15T09:30:00Z"
CustomFields holds custom field values for the company, keyed by custom field key.
Show child attributes
Show child attributes
Deleted is true when the object has been deleted; present only on delete responses.
Example:
true
FallbackColor is the hex color (e.g. "#4F46E5") used as the background when no icon image is set. The native pattern documents intent; the constraint is re-applied to the spec by the enrich-openapi post-processing step.
Pattern:
^#[0-9a-fA-F]{6}$Example:
"#4F46E5"
AvatarImageURL is the URL of the company's icon image. Images hosted outside Assembly are copied into Assembly storage and the stored URL is replaced with the copy.
Example:
"https://portal.example.com/icons/acme.png"
ID is the unique identifier of the object.
Example:
"550e8400-e29b-41d4-a716-446655440000"
IsPlaceholder is true when the company was auto-created as a placeholder. Read-only.
Example:
false
Name is the company's display name. Required on create.
Example:
"Acme Inc"
Object is the type of the object (e.g. "client", "company").
Available options:
client, internalUser, company, customField, customFieldOption, file, fileChannel, folder, messageChannel, message, notification Updated is the RFC 3339 timestamp at which the object was last updated.
Example:
"2024-02-20T14:05:00Z"