CustomFieldRequest

name · string · required

Maximum string length: 255

Example:

"An example name"

enabled · boolean · required

required · boolean · required

fieldType · enum<string> · required

Available options: text, checkbox, select

position · number · required

validationRules · object

Optional validation rules for the custom field

Show child attributes

validationRules. unique · boolean

If this field must be unique for every user in the environment

validationRules. regex · string

The regex pattern that the text field must match

Maximum string length: 255

Example:

"^0x"

validationRules. validOptions · object[]

The dropdown options for the select field

Show child attributes

validationRules.validOptions. label · string · required

Maximum string length: 255

Example:

"An example name"

validationRules.validOptions. key · string

Maximum string length: 255

Example:

"An example name"

Example:

[
  { "label": "small" },
  { "label": "medium" },
  { "label": "large" }
]

validationRules. checkboxText · string

The text that will be displayed for the checkbox field

Maximum string length: 255

Example:

"Agree to the terms and conditions"