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": "02eb0622-6b67-435f-8e2f-71d66f9437f9",
    "type": "form_fields",
    "attributes": {
      "team_id": 124,
      "slug": "test-update-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test update custom field",
      "description": "Omnis quia rerum minima.",
      "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-07-09T01:15:22.377-07:00",
      "created_at": "2025-07-09T01:15:17.989-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "5f62fe5a-6522-4c66-9b73-17d033366008",
            "type": "form_field_options"
          },
          {
            "id": "7fea98d1-9633-4acf-bf96-2f6aa3f4e379",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "c750589a-980a-4a96-9675-99ad8c994f45",
            "type": "form_field_positions"
          },
          {
            "id": "e7f67599-0890-44cd-9b38-bb8f15d300bc",
            "type": "form_field_positions"
          },
          {
            "id": "07fd2858-1a10-479f-8b20-1b42ff2db36a",
            "type": "form_field_positions"
          },
          {
            "id": "8f5c3dc3-6193-4e40-919e-2a09aedffec5",
            "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.