curl --request POST \
--url https://api.withallo.com/v2/api/crm/companies/attributes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "Industry segment",
"type": "DROPDOWN",
"options": [
{
"label": "SMB"
},
{
"label": "Enterprise"
}
],
"prompt": "Pick the segment that matches the company size mentioned on the call."
}
'import requests
url = "https://api.withallo.com/v2/api/crm/companies/attributes"
payload = {
"label": "Industry segment",
"type": "DROPDOWN",
"options": [{ "label": "SMB" }, { "label": "Enterprise" }],
"prompt": "Pick the segment that matches the company size mentioned on the call."
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: 'Industry segment',
type: 'DROPDOWN',
options: [{label: 'SMB'}, {label: 'Enterprise'}],
prompt: 'Pick the segment that matches the company size mentioned on the call.'
})
};
fetch('https://api.withallo.com/v2/api/crm/companies/attributes', 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.withallo.com/v2/api/crm/companies/attributes",
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([
'label' => 'Industry segment',
'type' => 'DROPDOWN',
'options' => [
[
'label' => 'SMB'
],
[
'label' => 'Enterprise'
]
],
'prompt' => 'Pick the segment that matches the company size mentioned on the call.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.withallo.com/v2/api/crm/companies/attributes"
payload := strings.NewReader("{\n \"label\": \"Industry segment\",\n \"type\": \"DROPDOWN\",\n \"options\": [\n {\n \"label\": \"SMB\"\n },\n {\n \"label\": \"Enterprise\"\n }\n ],\n \"prompt\": \"Pick the segment that matches the company size mentioned on the call.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.withallo.com/v2/api/crm/companies/attributes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Industry segment\",\n \"type\": \"DROPDOWN\",\n \"options\": [\n {\n \"label\": \"SMB\"\n },\n {\n \"label\": \"Enterprise\"\n }\n ],\n \"prompt\": \"Pick the segment that matches the company size mentioned on the call.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/crm/companies/attributes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Industry segment\",\n \"type\": \"DROPDOWN\",\n \"options\": [\n {\n \"label\": \"SMB\"\n },\n {\n \"label\": \"Enterprise\"\n }\n ],\n \"prompt\": \"Pick the segment that matches the company size mentioned on the call.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"key": "industry_segment",
"label": "Industry segment",
"type": "DROPDOWN",
"options": [
{
"key": "smb",
"label": "SMB"
},
{
"key": "enterprise",
"label": "Enterprise"
}
],
"is_visible": true,
"prompt": "Pick the segment that matches the company size mentioned on the call.",
"should_prompt_override": false,
"source": "allo",
"created_at": "2026-10-07T14:21:08",
"updated_at": "2026-10-07T14:21:08",
"already_existed": false
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Create company attribute
Creates a custom attribute on your team’s companies. The key is derived from the label. The call is idempotent: if an attribute with the same key and type already exists, it returns 201 with that attribute and already_existed set to true. options is required for DROPDOWN attributes and rejected for other types.
curl --request POST \
--url https://api.withallo.com/v2/api/crm/companies/attributes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"label": "Industry segment",
"type": "DROPDOWN",
"options": [
{
"label": "SMB"
},
{
"label": "Enterprise"
}
],
"prompt": "Pick the segment that matches the company size mentioned on the call."
}
'import requests
url = "https://api.withallo.com/v2/api/crm/companies/attributes"
payload = {
"label": "Industry segment",
"type": "DROPDOWN",
"options": [{ "label": "SMB" }, { "label": "Enterprise" }],
"prompt": "Pick the segment that matches the company size mentioned on the call."
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: 'Industry segment',
type: 'DROPDOWN',
options: [{label: 'SMB'}, {label: 'Enterprise'}],
prompt: 'Pick the segment that matches the company size mentioned on the call.'
})
};
fetch('https://api.withallo.com/v2/api/crm/companies/attributes', 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.withallo.com/v2/api/crm/companies/attributes",
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([
'label' => 'Industry segment',
'type' => 'DROPDOWN',
'options' => [
[
'label' => 'SMB'
],
[
'label' => 'Enterprise'
]
],
'prompt' => 'Pick the segment that matches the company size mentioned on the call.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.withallo.com/v2/api/crm/companies/attributes"
payload := strings.NewReader("{\n \"label\": \"Industry segment\",\n \"type\": \"DROPDOWN\",\n \"options\": [\n {\n \"label\": \"SMB\"\n },\n {\n \"label\": \"Enterprise\"\n }\n ],\n \"prompt\": \"Pick the segment that matches the company size mentioned on the call.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.withallo.com/v2/api/crm/companies/attributes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"Industry segment\",\n \"type\": \"DROPDOWN\",\n \"options\": [\n {\n \"label\": \"SMB\"\n },\n {\n \"label\": \"Enterprise\"\n }\n ],\n \"prompt\": \"Pick the segment that matches the company size mentioned on the call.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/crm/companies/attributes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"Industry segment\",\n \"type\": \"DROPDOWN\",\n \"options\": [\n {\n \"label\": \"SMB\"\n },\n {\n \"label\": \"Enterprise\"\n }\n ],\n \"prompt\": \"Pick the segment that matches the company size mentioned on the call.\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"key": "industry_segment",
"label": "Industry segment",
"type": "DROPDOWN",
"options": [
{
"key": "smb",
"label": "SMB"
},
{
"key": "enterprise",
"label": "Enterprise"
}
],
"is_visible": true,
"prompt": "Pick the segment that matches the company size mentioned on the call.",
"should_prompt_override": false,
"source": "allo",
"created_at": "2026-10-07T14:21:08",
"updated_at": "2026-10-07T14:21:08",
"already_existed": false
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}CRM_WRITEBody fields
| Field | Type | Required | Description |
|---|---|---|---|
label | string | yes | Display name, 1 to 255 characters, with at least one letter or digit |
type | string | yes | TEXT, NUMBER, DATE, BOOLEAN or DROPDOWN |
options | array | DROPDOWN only | At least one { label, key? } object. Rejected for other types |
prompt | string | no | Instruction the AI CRM Manager follows to fill this attribute from calls |
should_prompt_override | boolean | no | Whether the AI may overwrite a value that is already set |
Key derivation
Thekey is derived from the label: lowercase, accents removed, runs of non-alphanumeric characters replaced by _, truncated to 64 characters. Industry segment becomes industry_segment. Option keys are derived the same way.
A label that resolves to a reserved key is rejected with ATTRIBUTE_KEY_RESERVED. The reserved keys are: id, name, phone_numbers, website, industry, logo_url, last_activity, activity_history, sms_content, created_at and updated_at.
Response
Returns201 with the created attribute. source is allo, and already_existed is false.
{
"data": {
"key": "industry_segment",
"label": "Industry segment",
"type": "DROPDOWN",
"options": [
{ "key": "smb", "label": "SMB" },
{ "key": "enterprise", "label": "Enterprise" }
],
"is_visible": true,
"prompt": "Pick the segment that matches the company size mentioned on the call.",
"should_prompt_override": false,
"source": "allo",
"created_at": "2026-10-07T14:21:08",
"updated_at": "2026-10-07T14:21:08",
"already_existed": false
}
}
Creating the same attribute twice
The call is safe to repeat. If an attribute with the same key and type already exists, the endpoint returns201 with that attribute and already_existed set to true. Nothing is created and the existing definition is left unchanged. If the key exists with a different type, the request returns 409 ATTRIBUTE_KEY_CONFLICT.
Limits
Each type has a fixed number of slots per team. Once a type is full, creating another attribute of that type returns409 ATTRIBUTE_SLOTS_EXHAUSTED. Delete an unused attribute or use another type.
Custom attributes are only available to teams on the new contact model. Other teams get 404 TEAM_NOT_FOUND.
Errors
| Status | Code | When |
|---|---|---|
400 | ATTRIBUTE_LABEL_INVALID | label is blank, longer than 255 characters, or has no letter or digit |
400 | ATTRIBUTE_KEY_RESERVED | The label resolves to a reserved key |
400 | ATTRIBUTE_OPTION_INVALID | A DROPDOWN attribute has no options, or an option label is blank, longer than 255 characters or duplicated |
400 | ATTRIBUTE_OPTIONS_NOT_SUPPORTED | options sent for a type other than DROPDOWN |
400 | INVALID_REQUEST_BODY | type is missing or unknown |
403 | API_KEY_INSUFFICIENT_SCOPE | The key does not hold CRM_WRITE |
404 | TEAM_NOT_FOUND | The workspace is not on the new contact model |
409 | ATTRIBUTE_KEY_CONFLICT | An attribute with this key already exists with another type |
409 | ATTRIBUTE_SLOTS_EXHAUSTED | No free slot is left for this type |
409 | ATTRIBUTE_CONCURRENT_MODIFICATION | Attributes were modified at the same time. Retry the request |
Authorizations
Body
Display name of the attribute. The attribute key is derived from it: lowercase, accents removed, runs of non-alphanumeric characters replaced by _, truncated to 64 characters. Labels that resolve to a reserved key are rejected.
"Industry segment"
TEXT, NUMBER, DATE, BOOLEAN, DROPDOWN "DROPDOWN"
Allowed values. Required, with at least one option, for DROPDOWN; rejected for other types.
Show child attributes
Show child attributes
Instruction the AI CRM Manager follows to fill this attribute from calls. A blank value clears it.
"Pick the segment that matches the company size mentioned on the call."
Whether the AI may overwrite a value that is already set
Response
The attribute that was created, or the existing one when already_existed is true
A custom attribute on companies
Show child attributes
Show child attributes
Was this page helpful?