CustomFieldsResponse

id · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

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

key · string · required

Maximum string length: 255

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

Example:

"An example name"

name · string · required

Maximum string length: 255

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

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

Example:

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