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": "d2297d32-93a1-4e3d-a524-a61f99b33133",
    "type": "form_fields",
    "attributes": {
      "team_id": 180,
      "slug": "test-update-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test update custom field",
      "description": "Ea ut ipsum consequatur.",
      "shown": [
        "web_new_incident_form",
        "web_update_incident_form"
      ],
      "required": [],
      "default_values": [],
      "show_on_incident_details": false,
      "enabled": true,
      "updated_at": "2025-12-18T10:02:09.122-08:00",
      "created_at": "2025-12-18T10:02:06.353-08:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "d18f2197-a6f5-4df4-bfd3-710a1a36a574",
            "type": "form_field_options"
          },
          {
            "id": "36706bac-e4cf-4430-9167-50449dbeaa37",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "d0d7cf98-c81f-43d1-9170-f4dea8d9156b",
            "type": "form_field_positions"
          },
          {
            "id": "90af59d9-2825-41cb-9718-4c8848b29ffe",
            "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