fieldsAdd
Create a custom Field for a content type.
Auth · x-app-token · required permission manageForms
Related: fieldsEdit, fieldsRemove, fieldsGetDetail
fieldsAdd(contentType: String!, contentTypeId: String, type: String, validation: String, regexValidation: String, text: String, description: String, code: String, options: [String], locationOptions: [LocationOptionInput], isRequired: Boolean, order: Int, groupId: String, isVisible: Boolean, canHide: Boolean, associatedFieldId: String, logicAction: String, logics: [LogicInput], searchable: Boolean, showInCard: Boolean, objectListConfigs: [objectListConfigInput], isVisibleToCreate: Boolean): FieldArguments
Content type this field belongs to (required).
Id of the specific content-type record (e.g. form id), when applicable.
Input type. See fieldsGetTypes for allowed values.
Built-in validation rule, e.g. email, phone, number.
Custom regex pattern the value must match.
Question / label text shown to the user.
Helper text shown below the field label.
Stable machine code. Set once; prefer using it for later lookups.
Selectable choices for select / multiSelect / radio types.
Map pin presets when type is location.
Whether a value is required on submit. Default: false.
Sort order within the group.
FieldsGroup this field belongs to.
Whether the field is shown in list/detail views. Default: true.
Whether users are allowed to hide this field from views.
Id of another Field this field conditionally depends on.
show or hide — what happens when logics conditions match.
Conditional-display rules for this field.
Whether this field is indexed for search.
Whether this field appears on summary cards.
Column config when type is objectList.
Whether this field appears on the create form. Default: true.
Returns
Content type this field belongs to (e.g. customer, company, a form code).
Id of the specific content-type record (e.g. form id), when applicable.
Internal field name / label.
Whether the field is shown in list/detail views.
Whether the field is shown in the detail view specifically.
Whether users are allowed to hide this field from views.
FieldsGroup this field belongs to.
Map pin presets when type is location.
Column config when type is objectList.
Raw serialized options payload for select-like types.
Ids of nested Field rows for composite fields.
Conditional-display rules: show/require this field when associatedFieldId
matches a logicValue.
Helper text shown below the field label.
Selectable choices for select / multiSelect / radio types.
Input type, e.g. input, select, multiSelect, date, check, radio,
file, location, objectList. Drives which of options, locationOptions,
and objectListConfigs apply.
Built-in validation rule, e.g. email, phone, number.
Custom regex pattern the value must match.
Question / label text shown to the user.
Static content for read-only display fields.
Whether a value is required on submit.
Sort order within the group. See fieldsGroupsEdit.
show or hide — what happens when logics conditions match.
Column position for multi-column form layouts.
Page number for multi-page forms.
Stable machine code for this field. Prefer code over _id for lookups that
must survive re-imports — see fieldsGetDetail.
Whether this field is indexed for search.
Whether this field appears on summary cards.
Whether this field appears on the create form.
Product category this field is scoped to, when applicable.
true for built-in system fields shipped by Karzoun (cannot be removed via
fieldsRemove).