Skip to main content

CustomField

Stored in the customfields collection. createdAt and updatedAt are maintained automatically.

Returned by DELETE /custom-field, GET /custom-field, POST /custom-field, GET /custom-field/:id, PUT /custom-field/:id, PUT /custom-field/modify and 1 more.

FieldTypeNotes
namestringrequired
descriptionstring
sectionany
ordernumber
hidebooleandefault false
onlyShowTablebooleandefault false
panelstringdefault contact · one of contact, lead, productService
valueTypestringone of string, number, boolean, date, member, file, array, object and 1 more
fieldTypestringrequired · one of text, number, textarea, select, multi-select, file, checkbox, date and 4 more
requiredbooleandefault false
placeholderstring
helperstring
defaultValueany
optionsobject[]default []
options.labelstring
options.descriptionstring
options.valuestring
companyObjectId -> Companyrequired
uniqueFieldIDstringset once
childrenobject[]default []
children.namestring
children.descriptionstring
children.fieldTypestringrequired · one of text, number, textarea, select, multi-select, file, checkbox, date and 4 more
children.requiredbooleandefault false
children.placeholderstring
children.helperstring
children.defaultValueany
children.valueTypestringrequired · one of string, number, boolean, date, member, file, array, object and 1 more
children.optionsobject[]default []
children.options.labelstring
children.options.descriptionstring
children.options.valuestring
children.childrenobject[]default []
children._idObjectIddefault "6a95712f932657988a91c084"
createdByObjectId -> Member
updatedByObjectId -> Member
_idObjectIddefault "6a95712f932657988a91c085"
createdAtdateset once
updatedAtdate