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": "4c786a6b-2a4e-41fa-905b-31a0d6ace5cc",
    "type": "form_fields",
    "attributes": {
      "team_id": 125,
      "slug": "test-update-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test update custom field",
      "description": "Totam error modi placeat.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": false,
      "enabled": true,
      "updated_at": "2025-08-21T17:48:10.333-07:00",
      "created_at": "2025-08-21T17:48:07.202-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "32adac69-d34a-458d-b664-5e2f7acb8408",
            "type": "form_field_options"
          },
          {
            "id": "31ae63eb-a4ba-424c-a81e-6e303d1d6918",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "56e27975-f80d-4f41-91ba-35f949926295",
            "type": "form_field_positions"
          },
          {
            "id": "76e93101-04d0-4150-8ce5-55cd61ba3f5b",
            "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

Response

200
application/vnd.api+json

form_field updated

The response is of type object.