Skip to main content
MUTATION
fieldsEdit(_id: 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): Field

Arguments

_id
String!
required

Field id to update (required).

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

Returns

Field
_id
String!
contentType
String!

Content type this field belongs to (e.g. customer, company, a form code).

contentTypeId
String

Id of the specific content-type record (e.g. form id), when applicable.

name
String

Internal field name / label.

isVisible
Boolean

Whether the field is shown in list/detail views.

isVisibleInDetail
Boolean

Whether the field is shown in the detail view specifically.

canHide
Boolean

Whether users are allowed to hide this field from views.

groupId
String

FieldsGroup this field belongs to.

lastUpdatedUser
User
lastUpdatedUserId
String
associatedField
Field

Id of another Field this field is conditionally linked to via logics / logicAction.

locationOptions
[LocationOption]

Map pin presets when type is location.

objectListConfigs
[ObjectListConfig]

Column config when type is objectList.

optionsValues
String

Raw serialized options payload for select-like types.

subFieldIds
[String]

Ids of nested Field rows for composite fields.

subFields
[Field]
products
[Product]
logics
[Logic]

Conditional-display rules: show/require this field when associatedFieldId matches a logicValue.

description
String

Helper text shown below the field label.

options
[String]

Selectable choices for select / multiSelect / radio types.

type
String

Input type, e.g. input, select, multiSelect, date, check, radio, file, location, objectList. Drives which of options, locationOptions, and objectListConfigs apply.

validation
String

Built-in validation rule, e.g. email, phone, number.

regexValidation
String

Custom regex pattern the value must match.

text
String

Question / label text shown to the user.

content
String

Static content for read-only display fields.

isRequired
Boolean

Whether a value is required on submit.

order
Int

Sort order within the group. See fieldsGroupsEdit.

logicAction
String

show or hide — what happens when logics conditions match.

column
Int

Column position for multi-column form layouts.

pageNumber
Int

Page number for multi-page forms.

code
String

Stable machine code for this field. Prefer code over _id for lookups that must survive re-imports — see fieldsGetDetail.

searchable
Boolean

Whether this field is indexed for search.

showInCard
Boolean

Whether this field appears on summary cards.

isVisibleToCreate
Boolean

Whether this field appears on the create form.

productCategoryId
String

Product category this field is scoped to, when applicable.

field
String
isDefinedByKarzoun
Boolean

true for built-in system fields shipped by Karzoun (cannot be removed via fieldsRemove).

Mutation
Variables
Response
آخر تعديل في ١١ أغسطس ٢٠٢٦