Skip to main content

BuiltInFieldRule

Whether one built-in field is hidden, optional or required on one form.

type BuiltInFieldRule {
  defaultRule: String!
  field: String!
  rule: String!
  surface: String!
}

Fields​

BuiltInFieldRule.defaultRule ● String! non-null scalar​

What the form does for an organization that never changed the rule (today's behaviour).

BuiltInFieldRule.field ● String! non-null scalar​

The built-in field, e.g. customer.taxId, address.instructions or secondaryContact.phone.

BuiltInFieldRule.rule ● String! non-null scalar​

hidden, optional or required.

BuiltInFieldRule.surface ● String! non-null scalar​

The form: admin.form (console), sales_app.form, portal.form, buyer_app.form or signup (portal and buyer app sign-up).

Returned By​

builtInFieldRules query ● customerBuiltInFieldRules query ● customerSignupBuiltInFieldRules query ● mobileSignupBuiltInFieldRules query ● saveBuiltInFieldRules mutation