PUT
/
v1
/
form_fields
/
{id}
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": "a9e732b2-aa69-4160-92d8-c9fc877e516b",
    "type": "form_fields",
    "attributes": {
      "team_id": 127,
      "slug": "test-update-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test update custom field",
      "description": "Quibusdam id ad doloremque.",
      "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-06-21T11:58:56.595-07:00",
      "created_at": "2025-06-21T11:58:53.212-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "75def8b9-a78c-4ecf-8c8f-3ffcc8b161dc",
            "type": "form_field_options"
          },
          {
            "id": "ad57f97c-3bad-4667-80ed-589c103a8be5",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "e43c2cd7-3923-4f53-8639-6cb10d970c3e",
            "type": "form_field_positions"
          },
          {
            "id": "b559a451-d173-4e97-b3ca-ca72f0e8e3f5",
            "type": "form_field_positions"
          },
          {
            "id": "e6ecf8da-5827-41c6-85c3-e11dcf9b34aa",
            "type": "form_field_positions"
          },
          {
            "id": "29d7c1fe-5d29-42b1-b315-7f5ce032fd22",
            "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.