PUT
/
v1
/
custom_fields
/
{id}
curl --request PUT \
  --url https://api.rootly.com/v1/custom_fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "custom_fields",
    "attributes": {
      "label": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "shown": [
        "incident_form"
      ],
      "required": [
        "incident_form"
      ],
      "default": "<string>",
      "position": 123
    }
  }
}'
{
  "data": {
    "id": "2",
    "type": "custom_fields",
    "attributes": {
      "slug": "test-update-custom-field",
      "description": "Aut magni fugit quia.",
      "enabled": true,
      "position": 1,
      "updated_at": "2025-03-31T06:00:26.264-07:00",
      "created_at": "2025-03-31T06:00:22.509-07:00",
      "kind": "text",
      "label": "Test update custom field",
      "shown": [
        "incident_form"
      ],
      "required": []
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "4",
            "type": "custom_field_options"
          },
          {
            "id": "5",
            "type": "custom_field_options"
          }
        ]
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/vnd.api+json
​
data
object
required

Response

200
application/vnd.api+json
custom_field updated
​
data
object
required

Was this page helpful?