Create custom field

Creates a new custom field definition.

Body Fields

FieldTypeRequiredDescription
namestringYesInternal field name (used as key, no spaces)
labelstringYesDisplay label shown in the UI
typestringYesField type (see Field Types below)
scopestringYesEntity scope (see Scopes below)
requiredbooleanYesWhether the field is mandatory
formulastringNoFormula expression (required for Formula type)
optionsobjectNoOptions for Select/MultiSelect (see Options below)
weightintegerNoSort order/priority (lower = first)
sizestringNoCSS width class (e.g., w-full, w-1/2)
editablebooleanNoWhether users can edit (default: true)
publicbooleanNoWhether visible publicly
activatebooleanNoWhether the field is active (default: true)
enableAibooleanNoEnable AI features for this field
hubspotMapstringNoHubSpot property name to sync with
isMappedToHubspotbooleanNoEnable HubSpot sync

Field Types

TypeDescription
TextSingle-line text input
MultilineTextMulti-line text area
RichTextRich text editor (HTML)
NumberNumeric input
DateDate picker
datetimeDate and time picker
SelectSingle-choice dropdown
MultiSelectMultiple-choice dropdown
ImageImage upload
UserUser selector
FormulaCalculated field
HtmlRaw HTML content
SystemSystem-managed field

Scopes

ScopeDescription
dealDeal/opportunity fields
customerCustomer/contact fields
customer-companyCustomer company fields
productProduct catalog fields
quotationQuotation fields
quotation-lineQuotation line item fields

Options Object (for Select/MultiSelect)

{
  "items": [
    { "label": "Option 1" },
    { "label": "Option 2" }
  ]
}

Response

  • 201 Created: Custom field successfully created
  • 400 Bad Request: Invalid request body or validation error
  • 401 Unauthorized: Invalid or missing API key
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
string
string
boolean
integer
options
object
string
boolean
boolean
boolean
boolean
Responses
201

Resource created

400

Bad request

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!