Create a custom_field
Create a new custom field. book_id is accepted for backwards compatibility but ignored.
Authorizations
OAuth 2.0 Bearer Token from Clerk authentication
Headers
Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.
Body
Unique field key (lowercase, letters, numbers, underscores only)
"pageport_lead_source"
Human-readable field name
"Lead Source"
Entity type this field applies to (Client and Prospect normalize to Household)
Household, Person, Contact, Opportunity "Household"
Data type of the field
text, number, date, boolean, single_select, multi_select, cross_reference "text"
Deprecated. Ignored.
"abc123xyz"
Field-specific options (required for select fields and cross_reference)
Response
custom_field created
The custom field ID
"abc123xyz"
The unique field key
"pageport_lead_source"
The human-readable field name
"Lead Source"
The entity type this field applies to
Household, Person, Contact, Opportunity "Household"
The field data type
text, number, date, boolean, single_select, multi_select, cross_reference "text"
Field-specific options (e.g., select_options for select fields, cross_reference_allowed_target_types for cross_reference)