AppSaveCustomFieldInput

A field to add to the app's own namespace, or the new settings of one of its fields. The key, kind of record and type of an existing field cannot change.

input AppSaveCustomFieldInput {
  defaultValue: JSON
  entity: String!
  group: String
  helpText: JSON
  id: ID
  key: String!
  labels: JSON!
  options: JSON
  placements: [String!]!
  required: Boolean!
  requiredWhen: JSON
  rules: JSON
  showWhen: JSON
  sortOrder: Int
  type: String!
  visibility: String!
}

Fields

AppSaveCustomFieldInput.defaultValue ● JSON scalar

The starting value for new records.

AppSaveCustomFieldInput.entity ● String! non-null scalar

The kind of record, e.g. sales_order or sales_order_line.

AppSaveCustomFieldInput.group ● String scalar

A heading to group the field under.

AppSaveCustomFieldInput.helpText ● JSON scalar

Help text per language.

AppSaveCustomFieldInput.id ● ID scalar

The app's field to change; omit to add a new field.

AppSaveCustomFieldInput.key ● String! non-null scalar

Lower-case letters, digits and underscores, starting with a letter. Unique within the app's fields on one kind of record.

AppSaveCustomFieldInput.labels ● JSON! non-null scalar

The name per language: { [locale]: text }.

AppSaveCustomFieldInput.options ● JSON scalar

Choices for select fields.

AppSaveCustomFieldInput.placements ● [String!]! non-null scalar

Where the field appears. Never signup: an app's field is not on a sign-up form.

AppSaveCustomFieldInput.required ● Boolean! non-null scalar

Whether a form that shows the field refuses to save without a value.

AppSaveCustomFieldInput.requiredWhen ● JSON scalar

{ field, in }: require only when another of the app's fields matches.

AppSaveCustomFieldInput.rules ● JSON scalar

Length, range or item-count limits.

AppSaveCustomFieldInput.showWhen ● JSON scalar

{ field, in }: show only when another of the app's fields matches.

AppSaveCustomFieldInput.sortOrder ● Int scalar

Order among the record's fields; lower comes first. Default 0.

AppSaveCustomFieldInput.type ● String! non-null scalar

text, textarea, number, boolean, date, select, multiselect, phone, email or url.

AppSaveCustomFieldInput.visibility ● String! non-null scalar

staff, buyer_visible or buyer_editable, under the same rules as the organization's own fields.

Member Of

appSaveCustomField mutation