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": "0e130857-8b77-4bcd-8c70-5bf1324759d3",
    "type": "form_fields",
    "attributes": {
      "team_id": 89,
      "slug": "test-update-custom-field",
      "kind": "custom",
      "input_kind": "text",
      "value_kind": "inherit",
      "value_kind_catalog_id": null,
      "name": "Test update custom field",
      "description": "Quia rerum nihil ut.",
      "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-05-08T00:18:31.191-07:00",
      "created_at": "2025-05-08T00:18:26.189-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "7a1692cb-796d-4cd4-9830-29d15f21a4ee",
            "type": "form_field_options"
          },
          {
            "id": "2bcf6cbe-4d26-48a4-ba72-8aa413c6b3af",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "fef2ad93-77f0-4981-8a13-8bad35e7fdc6",
            "type": "form_field_positions"
          },
          {
            "id": "9420c13b-5dda-444c-838f-6fad7e7cb569",
            "type": "form_field_positions"
          },
          {
            "id": "cc6ac724-6fed-4b17-a8cc-d82b481f99e1",
            "type": "form_field_positions"
          },
          {
            "id": "cb7679cf-7a2d-4376-8492-c8cf57e1b4b5",
            "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.