Skip to main content
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": "d4610ee3-e7d7-4e54-ac23-af5422097822",
    "type": "form_fields",
    "attributes": {
      "team_id": 176,
      "slug": "test-update-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test update custom field",
      "description": "Dolores porro repellat provident.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": false,
      "enabled": true,
      "updated_at": "2025-11-27T00:07:48.554-08:00",
      "created_at": "2025-11-27T00:07:44.301-08:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "c639479d-cb9c-4e0c-9b44-bfb926ac211f",
            "type": "form_field_options"
          },
          {
            "id": "94395c52-0900-452a-8573-91ad08d11941",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "59be66b5-aca5-4d94-8da0-11f5c8764fb0",
            "type": "form_field_positions"
          },
          {
            "id": "51fa56d2-5392-418d-a1e1-c63f1dcdf3ca",
            "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
required

Resource UUID

Body

application/vnd.api+json
​
data
object
required

Response

form_field updated

​
data
object
required