Custom Fields
Create contact custom field
Creates a new custom field definition for contacts. Requires crm:write scope.
POST
/
contacts
/
custom-fields
Create Contact Custom Field
curl --request POST \
--url https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"field_name": "Partner Tier",
"field_key": "partner_tier",
"field_type": "dropdown",
"options": [
"Registered",
"Certified",
"Premier"
],
"is_required": false
}
'import requests
url = "https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields"
payload = {
"field_name": "Partner Tier",
"field_key": "partner_tier",
"field_type": "dropdown",
"options": ["Registered", "Certified", "Premier"],
"is_required": 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({
field_name: 'Partner Tier',
field_key: 'partner_tier',
field_type: 'dropdown',
options: ['Registered', 'Certified', 'Premier'],
is_required: false
})
};
fetch('https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields', 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://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields",
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([
'field_name' => 'Partner Tier',
'field_key' => 'partner_tier',
'field_type' => 'dropdown',
'options' => [
'Registered',
'Certified',
'Premier'
],
'is_required' => 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://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields"
payload := strings.NewReader("{\n \"field_name\": \"Partner Tier\",\n \"field_key\": \"partner_tier\",\n \"field_type\": \"dropdown\",\n \"options\": [\n \"Registered\",\n \"Certified\",\n \"Premier\"\n ],\n \"is_required\": 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://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field_name\": \"Partner Tier\",\n \"field_key\": \"partner_tier\",\n \"field_type\": \"dropdown\",\n \"options\": [\n \"Registered\",\n \"Certified\",\n \"Premier\"\n ],\n \"is_required\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields")
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 \"field_name\": \"Partner Tier\",\n \"field_key\": \"partner_tier\",\n \"field_type\": \"dropdown\",\n \"options\": [\n \"Registered\",\n \"Certified\",\n \"Premier\"\n ],\n \"is_required\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cf_55102a",
"entity_type": "lead",
"field_name": "Expected Close Date",
"field_key": "expected_close_date",
"field_type": "date",
"options": [
"Bronze",
"Silver",
"Gold",
"Platinum"
],
"is_required": false,
"created_at": "2026-10-26T06:00:00.000Z",
"updated_at": "2026-10-26T06:00:00.000Z"
},
"error": null
}{
"success": false,
"data": null,
"error": {
"message": "Validation failed",
"details": [
{
"message": "Required",
"field": "email",
"code": "invalid_type"
}
]
}
}{
"success": false,
"data": null,
"error": {
"message": "Invalid or missing API key."
}
}{
"success": false,
"data": null,
"error": {
"message": "Forbidden: insufficient permissions for this operation."
}
}Creates a new custom field definition for contacts.
Options requirement
When settingfield_type to dropdown or multi_select, you must supply an array of allowed values in the options property.
Required permissions
Requires an API key with thecrm:write scope.Authorizations
Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.
Body
application/json
Example:
"Partner Tier"
Example:
"partner_tier"
Available options:
text, number, date, dropdown, multi_select Example:
"dropdown"
Required when field_type is dropdown or multi_select
Example:
["Registered", "Certified", "Premier"]
Example:
false
⌘I
Create Contact Custom Field
curl --request POST \
--url https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"field_name": "Partner Tier",
"field_key": "partner_tier",
"field_type": "dropdown",
"options": [
"Registered",
"Certified",
"Premier"
],
"is_required": false
}
'import requests
url = "https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields"
payload = {
"field_name": "Partner Tier",
"field_key": "partner_tier",
"field_type": "dropdown",
"options": ["Registered", "Certified", "Premier"],
"is_required": 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({
field_name: 'Partner Tier',
field_key: 'partner_tier',
field_type: 'dropdown',
options: ['Registered', 'Certified', 'Premier'],
is_required: false
})
};
fetch('https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields', 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://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields",
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([
'field_name' => 'Partner Tier',
'field_key' => 'partner_tier',
'field_type' => 'dropdown',
'options' => [
'Registered',
'Certified',
'Premier'
],
'is_required' => 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://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields"
payload := strings.NewReader("{\n \"field_name\": \"Partner Tier\",\n \"field_key\": \"partner_tier\",\n \"field_type\": \"dropdown\",\n \"options\": [\n \"Registered\",\n \"Certified\",\n \"Premier\"\n ],\n \"is_required\": 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://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"field_name\": \"Partner Tier\",\n \"field_key\": \"partner_tier\",\n \"field_type\": \"dropdown\",\n \"options\": [\n \"Registered\",\n \"Certified\",\n \"Premier\"\n ],\n \"is_required\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://crm-api.automatebusiness.com/api/v1/integrations-public/contacts/custom-fields")
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 \"field_name\": \"Partner Tier\",\n \"field_key\": \"partner_tier\",\n \"field_type\": \"dropdown\",\n \"options\": [\n \"Registered\",\n \"Certified\",\n \"Premier\"\n ],\n \"is_required\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cf_55102a",
"entity_type": "lead",
"field_name": "Expected Close Date",
"field_key": "expected_close_date",
"field_type": "date",
"options": [
"Bronze",
"Silver",
"Gold",
"Platinum"
],
"is_required": false,
"created_at": "2026-10-26T06:00:00.000Z",
"updated_at": "2026-10-26T06:00:00.000Z"
},
"error": null
}{
"success": false,
"data": null,
"error": {
"message": "Validation failed",
"details": [
{
"message": "Required",
"field": "email",
"code": "invalid_type"
}
]
}
}{
"success": false,
"data": null,
"error": {
"message": "Invalid or missing API key."
}
}{
"success": false,
"data": null,
"error": {
"message": "Forbidden: insufficient permissions for this operation."
}
}