PUT
/
v1
/
form_fields
/
{id}
Update a Form Field
curl --request PUT \
  --url https://api.rootly.com/v1/form_fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "type": "form_fields",
    "attributes": {
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "shown": [
        "<string>"
      ],
      "required": [
        "<string>"
      ],
      "show_on_incident_details": true,
      "enabled": true,
      "default_values": [
        "<string>"
      ]
    }
  }
}'
{
  "data": {
    "id": "3a3a0ec4-11f0-4ecb-896b-aaa50366ad88",
    "type": "form_fields",
    "attributes": {
      "team_id": 124,
      "slug": "test-update-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test update custom field",
      "description": "Ut qui enim nemo.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form",
        "slack_new_incident_form",
        "slack_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": false,
      "enabled": true,
      "updated_at": "2025-07-11T12:25:14.136-07:00",
      "created_at": "2025-07-11T12:25:09.751-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "a10db1a9-6fe0-4b4d-ba8c-96437fd28d74",
            "type": "form_field_options"
          },
          {
            "id": "ee336154-c3b7-4a04-b79d-6cbb64f81274",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "d40cf533-c921-4d31-b9b7-321d0f6bc823",
            "type": "form_field_positions"
          },
          {
            "id": "a6988692-d94a-453d-8164-7607b75a38dc",
            "type": "form_field_positions"
          },
          {
            "id": "6fc7ba6a-8c50-411f-81e8-3753af14254c",
            "type": "form_field_positions"
          },
          {
            "id": "9bbbefbb-9146-4f7a-9d73-c53b032b1e5a",
            "type": "form_field_positions"
          }
        ]
      }
    }
  }
}

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

Response

200
application/vnd.api+json

form_field updated

The response is of type object.