Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Custom Fields

Create a new custom field for an environment

post/environments/{environmentId}/custom/fields

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Request body

namestring required
enabledboolean required
requiredboolean required
fieldType'text' | 'checkbox' | 'select' required
positionnumber required

Example request

{
  "name": "An example name",
  "validationRules": {
    "regex": "^0x",
    "validOptions": [
      {
        "label": "small"
      },
      {
        "label": "medium"
      },
      {
        "label": "large"
      }
    ],
    "checkboxText": "Agree to the terms and conditions"
  }
}

Response

Custom field created successfully

idstring required
keystring required
namestring required
enabledboolean required

A flag indicating whether the custom field is active.

requiredboolean required

A flag indicating whether the custom field is required.

fieldType'text' | 'checkbox' | 'select' required
positionnumber required

Example response

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