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": "82426ec6-8749-4e82-b555-a804109ec503",
    "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": "A tenetur ut eveniet.",
      "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-18T19:32:26.433-07:00",
      "created_at": "2025-06-18T19:32:22.829-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "2a8ec042-dc2b-4ee0-9464-d24f18ef9018",
            "type": "form_field_options"
          },
          {
            "id": "9c4c4ca0-0fb2-4b8b-8d2e-7b8863c14c49",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "bd9d11ad-15f9-4d5f-95db-89d13e8602d0",
            "type": "form_field_positions"
          },
          {
            "id": "47342d45-d527-4f6b-92fe-cb94bea02ca8",
            "type": "form_field_positions"
          },
          {
            "id": "cb12f380-20fc-4eb5-8c74-573d96e75d13",
            "type": "form_field_positions"
          },
          {
            "id": "aae156a9-0e09-484f-b7a0-eea6c7d9ce2b",
            "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.