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": "7f62cce6-503b-4bd6-963a-193cfe5ea36f",
    "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": "Quo asperiores ea eius.",
      "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-04-18T09:46:46.990-07:00",
      "created_at": "2025-04-18T09:46:42.129-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "3cfcce6c-68bd-4bcc-8791-569f0863520f",
            "type": "form_field_options"
          },
          {
            "id": "f66a576b-6897-43e8-9090-929557260761",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "7113f884-ec6d-4770-a9a9-0633ceb24bb4",
            "type": "form_field_positions"
          },
          {
            "id": "5c2a7843-7db8-46a6-a733-f94cb2322db6",
            "type": "form_field_positions"
          },
          {
            "id": "779efb74-91a2-4bf0-9d3c-56fc2a5ed34c",
            "type": "form_field_positions"
          },
          {
            "id": "b9375daa-0800-4da5-be50-402d43d2be66",
            "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
data
object
required

Response

200
application/vnd.api+json
form_field updated
data
object
required