What are Custom Fields?
Custom fields allow you to add extra information to leads beyond the standard fields (name, email, phone, company).Field Types
text
Free text field
number
Numeric value
date
Date/time
boolean
True or false
select
Selection from predefined options
Usage Flow
1
Create Definition
Define the field: name, type, options (for select), default value.
2
Apply Values
Set field values for specific leads.
3
Use in Templates
Use variables like
{{LEAD_FIELD_NAME}} in messages and prompts.Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /backend/custom-fields | List definitions |
POST | /backend/custom-fields | Create definition |
PUT | /backend/custom-fields/{id} | Update definition |
DELETE | /backend/custom-fields/{id} | Remove definition |
GET | /backend/custom-fields/variables | List variables |
GET | /backend/lead-fields/{lead_id} | Values for a lead |
PUT | /backend/lead-fields/{lead_id}/{field_id} | Set value |
Available Variables
Variables can be used in cadence messages and AI prompts:Standard Variables
| Variable | Description |
|---|---|
{{LEAD_NAME}} | Lead’s full name |
{{LEAD_FIRSTNAME}} | Lead’s first name |
{{LEAD_NUMBER}} | Lead’s phone |
{{COMPANY_NAME}} | Company name |
Custom Field Variables
Custom fields are accessed as:{{LEAD_FIELD_KEY}}
Example: If you create a field with field_key: "lead_source", the variable will be {{LEAD_LEAD_SOURCE}}