Custom Field Data Structure

{
  "cf_custom_text_field": "custom text",
  "cf_custom_large_txt_field": "sdkfj",
  "cf_custom_number_field": 10,
  "cf_custom_dropdown_field": 10413746,
  "cf_custom_multiselect_field": [
    10413746,
    10413747
  ],
  "cf_custom_owner_field": 71591,
  "cf_custom_company_field": 121728,
  "cf_custom_contact_field": 1186422,
  "cf_custom_monetory_field": {
    "currency": 1,
    "value": 1.2345678901234568E12
  },
  "cf_custom_phone_field": [
    {
      "phone_type": 1,
      "phone_number": "10101010101010101"
    }
  ],
  "cf_custom_email_field": [
    {
      "email_type": 2,
      "email_value": "sss@hvu.in"
    }
  ],
  "cf_custom_time_field": "2025-05-15T10:15:30",
  "cf_custom_date_field": "2026-07-01T12:55:00",
  "cf_custom_date_range_field": {
    "range": {
      "from": "2026-07-01T12:55:00+05:30",
      "to": "2026-07-02T12:50:00+05:30"
    }
  },
  "cf_custom_date_time_range_field": {
    "range": {
      "from": "2026-07-01T12:55:00Z",
      "to": "2026-07-02T12:50:00Z"
    }
  }
}

Custom Field Types

Field	Type	Required	Description	Validation
cf_custom_text_field	string	Optional	Single-line text custom field. Example: "custom text"	A maximum of 255 characters
cf_custom_large_txt_field	string	Optional	Multi-line (large text) custom field. Example: "sdkfj"	A maximum of 32000 characters
cf_custom_number_field	number	Optional	Numeric custom field. Example: 10	A maximum of 16 digits
cf_custom_dropdown_field	number	Optional	Single-select dropdown custom field. Dynamic - options are account-specific; fetch via API. Example: 10413746	A maximum of 100 options
cf_custom_multiselect_field	array<number/name>	Optional	Multi-select dropdown custom field, list of selected option IDs or names. Dynamic - fetch options via API. Example: [10413746, 10413747]	A maximum of 100 options
cf_custom_address_field	array	Optional	Address type custom field. See Address Object.	Address line 1 - maximum of 300 characters. Address line 2 - maximum of 300 characters. City - maximum of 125 characters. State - maximum of 125 characters. Pin code - maximum of 25 numbers
cf_custom_owner_field	number	Optional	Owner-type custom field. ID of the user (owner) selected. Example: 71591	-
cf_custom_company_field	number	Optional	Company-type custom field. ID of the linked company. Example: 121728	-
cf_custom_contact_field	number	Optional	Contact-type custom field. ID of the linked contact. Example: 1186422	-
cf_custom_monetory_field	object	Optional	Monetary-type custom field. See Money Object below.	A maximum of 13 digits including decimals. Only the digits 0-9 and the dot (.) are allowed. The limit is 13 characters, including decimals. When the decimal value is entered, only 2 digits are allowed after the dot.
cf_custom_phone_field	array<object>	Optional	Phone-type custom field. See Phone Object.	A minimum of 5 and a maximum of 17 characters
cf_custom_email_field	array<object>	Optional	Email-type custom field. See Email Object.	A maximum of 320 characters. Enter a valid email address
cf_custom_time_field	string (time)	Optional	Time-only custom field, ISO 8601 without offset. Example: "2025-05-15T10:15:30"	HH:MM
cf_custom_date_field	datetime	Optional	Date-type custom field, ISO 8601. Example: "2026-07-01T12:55:00"	DD MM YYYY
cf_custom_time_range_field	string (time)	Optional	Time range custom field. ISO 8601 without offset.	HH:MM To HH:MM
cf_custom_date_range_field	object	Optional	Date range custom field. See Date Range Object.	DD MM YYYY To DD MM YYYY
cf_custom_date_time_range_field	object	Optional	Date-time range custom field with timezone offset. See Date-Time Range Object.	DD MM YYYY HH:MM

Nested Objects

Nested Object - Phone

Each item in the phones array represents one phone number entry.

Field	Type	Required	Description
phone_type	number or string	Required	Enum ID or name indicating the phone type. Available values: 1 - work 2 - phone 3 - mobile 4 - whatsapp 5 - telegram 6 - personal 7 - other
phone_number	string	Required	The phone number as a string. Include country code where applicable. Example: "10101010101010101"

Note: If an invalid field type is provided, the field type will default to Work.

Nested Object - Emails

Each item in the emails array represents one email address entry.

Field	Type	Required	Description
email_type	number or string	Required	Enum ID or name indicating the email type. Available values: 1 - work 2 - personal 3 - home 4 - other
email_value	string	Required	A valid email address string. Example: "sss@hvu.in"

Note: If an invalid field type is provided, the field type will default to Work.

Nested Object - Address

A single object describing the contact's primary address.

Field	Type	Required	Description
address_line1	string	Optional	Primary street address line. Example: "123 Maple Street"
address_line2	string	Optional	Secondary street address line. Example: "Suite 405, Downtown District"
city	string	Optional	City of the contact's address. Example: "Austin"
state	string	Optional	State or province of the contact's address. Example: "Texas"
country	number or string	Optional	Numeric ID or name representing the country. Refer to the Countries reference list in your system. Example: 165, United States
zipcode	string	Optional	Postal / ZIP code of the address. Stored as a string to preserve leading zeros. Example: "78701"

Nested Object - Monetary

Field	Type	Required	Description
currency	number/code/name	Required	ID, code, or name of the currency the value is denominated in. Example: 3, US, United States

Date and Time Type

Date/Time-type custom fields currently support values in the ISO 8601 format.

Support for additional date/time formats may be introduced in future versions.