SAsaleshandy
fields

Create a custom field

Changed on

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.

post/v1/fields

Request

Request body

labelstring required

The display name of the custom field. This label will appear in the prospect profile and throughout the application.

fieldType'text' | 'number' | 'date' | 'long-text' | 'dropdown' | 'currency' required

The data type of the custom field. Accepted values: text, number, date, long-text, dropdown, currency.

fallbackTextstring

A default placeholder text to display when the field has no value for a prospect.

metadataobject

Per-type configuration. Required for Dropdown and Currency fields, ignored for others. For Dropdown (fieldType "dropdown"): <code>{ "options": ["Free", "Growth", "Enterprise"] }</code> — list of selectable values (max 50). For Currency (fieldType "currency"): <code>{ "currencyCode": "USD" }</code> — ISO 4217 code from USD, EUR, GBP, JPY, CHF, CAD, AUD, CNY, INR, SGD, HKD, NZD, KRW, SEK, AED, BRL, MXN, ZAR, SAR.

tagsstring[]

Freeform tags for finding this field later (separate namespace from Prospect Tags). Never blocks create — resolved case-insensitively, existing tags reused.

Example request

{
  "label": "LinkedIn Profile URL",
  "fieldType": "text",
  "fallbackText": "Not provided",
  "metadata": {
    "options": [
      "Free",
      "Growth",
      "Enterprise"
    ]
  },
  "tags": [
    "CRM",
    "Sales"
  ]
}

Response

Custom field created successfully

unknown required

Example response

{
  "message": "Custom field created successfully",
  "payload": {
    "id": "Vj9kLp2Q",
    "label": "LinkedIn URL",
    "isDefault": false,
    "fieldType": "text"
  }
}

Changes