Create a custom field

Create a new custom field for your team. Custom fields extend person and company records with additional data.

Field Types:

  • text - Single-line text (default)
  • number - Numeric values
  • date - Date values (ISO 8601 format)
  • dropdown - Single-select from predefined choices
  • multi_select - Multi-select from predefined choices

Important Notes:

  • Field name must be unique within your team
  • Field name should use lowercase with underscores (e.g., "lead_score", "property_budget")
  • For dropdown and multi_select fields, you must provide a choices array
  • Use appliesTo to specify whether field is for people, companies, or both

Examples:

Text Field:

{
  "name": "referral_source",
  "label": "Referral Source",
  "fieldType": "text",
  "appliesTo": "people"
}

Dropdown Field:

{
  "name": "buyer_stage",
  "label": "Buyer Stage",
  "fieldType": "dropdown",
  "appliesTo": "people",
  "choices": ["Pre-Qualified", "House Hunting", "Under Contract", "Closed"]
}

Multi-Select Field:

{
  "name": "property_interests",
  "label": "Property Interests",
  "fieldType": "multi_select",
  "appliesTo": "people",
  "choices": ["Single Family", "Condo", "Townhouse", "Commercial"]
}

Number Field:

{
  "name": "property_budget",
  "label": "Property Budget",
  "fieldType": "number",
  "appliesTo": "people",
  "description": "Maximum budget for property purchase"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Internal field name (lowercase with underscores)

string
required

Display label

string
enum
required

Field data type

Allowed:
string
enum
required

Which entities this field applies to

Allowed:
boolean

Whether this field is required

string | null

Default value for new records

string | null

Help text or description

choices
array of strings

Options for dropdown and multi_select fields (required for dropdown and multi_select types)

choices
boolean

Whether this date field is treated as recurring (e.g., birthdays, anniversaries)

Responses
201

custom field created

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json