v1

latestOpenAPI 3.0.32026-08-067332206.6 KB

custom_fields

Update a custom field key

Update the matching custom field key.

Warning: It is NOT recommended to update keys that are currently in use. Changing allowed values or whether they are restricted after other values have already been used can lead to undesirable results.

put/custom_field_keys/{custom_field_key_id}

Headers

Accept'application/json' required

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "color",
      "allowed_values": [
        "orange",
        "gray",
        "green"
      ]
    }
  }
}

Response

The updated custom field key.

Example response

{
  "data": {
    "id": "plqlkk-22rw6g-3dqgx0",
    "attributes": {
      "name": "color",
      "allowed_values": [
        "orange",
        "gray",
        "green"
      ],
      "restricted": true
    }
  }
}