Create Custom Field
POST /v1/fields
/v1/fieldsCreate a custom field
Creates a new custom field that can be used to store additional information on prospect profiles. Supported field types are Text, Number, Long Text, Currency, Date, and Dropdown.
Authorization
x-api-key<token>
API key for Open API authentication
In: header
Request Body
application/jsonRequiredProvide label (required) and fieldType (required). fieldType accepted values: "text", "number", "date", "long-text", "dropdown", "currency". For Dropdown fields, pass metadata.options array. For Currency fields, pass metadata.currencyCode (ISO 4217). fallbackText is optional — shown when a prospect has no value for this field.
labelstring
The display name of the custom field. This label will appear in the prospect profile and throughout the application.
Example:"LinkedIn Profile URL"fieldTypestring
The data type of the custom field. Accepted values: text, number, date, long-text, dropdown, currency.
Example:"text"Value in: "text" | "number" | "date" | "long-text" | "dropdown" | "currency"fallbackTextstring
A default placeholder text to display when the field has no value for a prospect.
Example:"Not provided"metadataobject
Per-type configuration. Required for Dropdown and Currency fields, ignored for others. For Dropdown (fieldType "dropdown"): { "options": ["Free", "Growth", "Enterprise"] } — list of selectable values (max 50). For Currency (fieldType "currency"): { "currencyCode": "USD" } — ISO 4217 code from USD, EUR, GBP, JPY, CHF, CAD, AUD, CNY, INR, SGD, HKD, NZD, KRW, SEK, AED, BRL, MXN, ZAR, SAR.
{"options":["Free","Growth","Enterprise"]}Request Body Examples
{
"label": "LinkedIn Profile URL",
"fieldType": "text"
}Responses
{
"message": "Custom field created successfully",
"payload": {
"id": "Vj9kLp2Q",
"label": "LinkedIn URL",
"isDefault": false,
"fieldType": "text"
}
}