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

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 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"]
}

Number Field:

{
  "name": "property_budget",
  "label": "Property Budget",
  "fieldType": "number",
  "appliesTo": "people",
  "description": "Maximum budget for property purchase"
}
Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!