customField.idstring
Example:3sv6UEo51C9Bmpo1cKTq
customField.namestring
Example:pincode
customField.fieldKeystring
Example:contact.pincode
customField.placeholderstring
Example:Pin code
customField.dataTypestring
Data type of the custom field.
URL, USER, TIME, DATE_TIME and RICH_TEXT are Labs-only for now.
Available optionsTEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSFLOATTIMEDATETEXTBOX_LIST
Example:TEXT
customField.positionnumber
Example:0
customField.picklistOptionsstring[]
Example:["first option"]
customField.picklistImageOptionsstring[]
Example:[]
customField.isAllowedCustomOptionboolean
Example:false
customField.isMultiFileAllowedboolean
Example:true
customField.maxFileLimitnumber
Example:4
customField.locationIdstring
Example:3sv6UEo51C9Bmpo1cKTq
customField.modelstring
Model of the custom field
Available optionscontactopportunity
Example:opportunity
customField.urlValidationobject
URL validation (URL fields). Labs-only as of now.
customField.urlValidation.modestring
allow_all: any url. allow_only: only allowedDomains. block: anything but blockedDomains.
Available optionsallow_allallow_onlyblock
Example:allow_all
customField.urlValidation.allowedDomainsstring[]
Domains accepted when mode is allow_only
Example:["example.com"]
customField.urlValidation.blockedDomainsstring[]
Domains rejected when mode is block
Example:[]
customField.dateTimeValidationobject
Date/time validation (DATE, TIME, DATE_TIME). DATE_TIME and TIME are Labs-only as of now.
customField.dateTimeValidation.modestring
any: no restriction. future_only: value must be in future. past_only: value must be in past. range: value within rangeMin-rangeMax.
Available optionsanyfuture_onlypast_onlyrange
Example:any
customField.dateTimeValidation.bufferDaysnumber
For future_only: minimum days from today before a date is selectable
Example:2
customField.dateTimeValidation.rollingDaysnumber
For future_only: rolling window in days from today (e.g. 30 = next 30 days). Mutually exclusive with bufferDays.
Example:30
customField.dateTimeValidation.rangeMinstring
Required when mode is range. ISO date or datetime string
Example:2026-01-01
customField.dateTimeValidation.rangeMaxstring
Required when mode is range. ISO date or datetime string
Example:2026-12-31
customField.dateTimeValidation.daysAllowednumber[]
Days of week 0=Sunday..6=Saturday. Works alongside future_only, past_only, or range modes.
Example:[1,2,3,4,5]
customField.dateTimeValidation.inputTypestring
For DATE_TIME fields: collect date only, time only, or both (defaults per product if omitted).
Available optionsdate_onlytime_onlydate_and_time
Example:date_and_time
customField.userFieldConfigobject
User field config (USER fields). Labs-only as of now.
customField.userFieldConfig.multiSelectboolean
Single or multi-select; cannot change after create
Example:false
customField.optionDisplayTypestring
Option rendering mode for RADIO / CHECKBOX. One of TEXT_ONLY, TEXT_WITH_ICON, TEXT_WITH_IMAGE.
Available optionsTEXT_ONLYTEXT_WITH_ICONTEXT_WITH_IMAGE
Example:TEXT_WITH_IMAGE