Custom Fields

Custom fields allow you to store additional data on contacts beyond the standard fields. The Custom Fields API allows you to define field schemas that can then be used to store values on individual contacts.

Overview

Custom fields define the structure and type of additional data you want to track for your contacts. Once a field is created, you can set values for that field on any contact using the Contact Custom Fields endpoints.

Field Types

Type	Description	Example Value
text	Free-form text	"Acme Inc"
number	Numeric values (integer or decimal)	42, 3.14
date	Date without time	"2025-01-15"
datetime	Date with time	"2025-01-15T10:30:00Z"
boolean	True or false	true, false
select	Predefined options	"enterprise"
list	Multiple free-form string values	["Webinar X", "Webinar Y"]

Endpoints

Method	Endpoint	Description
POST	/custom-fields	Create a new custom field
GET	/custom-fields	List all custom fields
GET	/custom-fields/{uuid}	Get a specific custom field
PATCH	/custom-fields/{uuid}	Update a custom field
DELETE	/custom-fields/{uuid}	Delete a custom field

Custom Field Object

Field	Type	Description
uuid	string	Unique identifier for the field
field_key	string	Unique key used to reference the field
name	string	Display name
type	string	Field type (text, number, date, datetime, boolean, select, list)
options	array|null	Options for select fields, null for other types
created_at	string	ISO 8601 timestamp (UTC)