Sign in

v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Contacts Custom Fields

POST (create) a custom_field

Custom fields are extra data fields you create to store additional information about your contacts, such as preferences, membership levels, and interests. Use custom fields to organize contacts, send personalized email campaigns, and to identify a targeted audience for a specific campaign. Custom fields types include text, number, date, drop-down lists, radio buttons, and checkboxes. A user can configure up to 100 custom_fields in their account.

post/contact_custom_fields

Request body

labelstring

The custom field name to display in the UI (free-form text).

typestring

The type of data to store in the custom field.

versioninteger

Available if data type is <code>data</code>. Displays <code>1</code> if using legacy date fields where values are stored as strings. Displays <code>2</code> if using new date fields where values are stored as actual dates to support date comparisons and validations.

Example request

{
  "label": "Favorite Fruit",
  "type": "string",
  "metadata": {
    "display_type": "radio",
    "decimal_places": 1,
    "currency_code": "USD",
    "integer": true,
    "display_format": "MM/DD/YYYY"
  },
  "choices": [
    {
      "choice_label": "Apple",
      "display_order": 1
    }
  ],
  "version": 2
}

Response

New custom field successfully created

custom_field_idstring uuid

The system generated ID that uniquely identifies a <code>custom_field</code>.

labelstring required

The custom field name to display in the UI (free-form text).

namestring

The unique custom field name constructed from the label by replacing blanks with underscores.

typestring required

The data value type the custom field accepts.

versioninteger

For <code>datetime</code> data types, this is the version number associated with the custom field.

updated_atstring date-time

System generated date and time that the resource was updated, in ISO-8601 format.

created_atstring date-time

Date and time that the resource was created, in ISO-8601 format. System generated.

Example response

{
  "custom_field_id": "1618ae62-4752-11e9-9c8a-fa163e6b01c1",
  "label": "Vehicle make and model year",
  "name": "Vehicle_make_and_model_year",
  "type": "date",
  "metadata": {
    "display_type": "radio",
    "decimal_places": 1,
    "currency_code": "USD",
    "integer": true,
    "display_format": "MM/DD/YYYY"
  },
  "version": 1,
  "choices": [
    {
      "custom_field_id": "d0737000-afbf-11ee-874a-eaf5d7a2e15d",
      "choice_label": "Apple",
      "display_order": 1,
      "created_at": "2024-06-27T10:28:09.000Z",
      "updated_at": "2024-06-27T10:28:09.000Z",
      "deleted_at": "2023-12-18"
    }
  ],
  "updated_at": "2016-01-23T13:48:44.108Z",
  "created_at": "2016-03-03T10:53:04-05:00"
}