CustomFieldRequest

name

string

required

Maximum string length: 255

Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

enabled

boolean

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

CustomFieldType

⌘I

{
  "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"
  }
}

Overview

Endpoints

Schemas

CustomFieldRequest

Overview

Endpoints

Schemas

Documentation Index