CustomFieldsResponse

id · string · required

Required string length: 36

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

key · string · required

Maximum string length: 255

Example:

"An example name"

name · string · required

Maximum string length: 255

Example:

"An example name"

enabled · boolean · required

A flag indicating whether the custom field is active.

required · boolean · required

A flag indicating whether the custom field is 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"

Example:

{
  "title": "Example",
  "value": [
    {
      "id": "95b11417-f18f-457f-8804-68e361f9164f",
      "key": "An example name",
      "name": "An example name",
      "enabled": true,
      "required": true,
      "fieldType": "text",
      "position": 123,
      "validationRules": {
        "unique": true,
        "regex": "^0x",
        "validOptions": [
          { "label": "small" },
          { "label": "medium" },
          { "label": "large" }
        ],
        "checkboxText": "Agree to the terms and conditions"
      }
    }
  ]
}