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": "44bd7ac9-9da6-4880-94a3-a5c4a1b1ad61",
    "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": "Vitae velit in distinctio.",
      "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-03-19T07:49:57.992-07:00",
      "created_at": "2025-03-19T07:49:53.593-07:00"
    },
    "relationships": {
      "options": {
        "data": [
          {
            "id": "d9a23b2f-94b7-480c-a550-7a4813443635",
            "type": "form_field_options"
          },
          {
            "id": "795cc89d-9c0f-4c5a-986d-0db4359a226a",
            "type": "form_field_options"
          }
        ]
      },
      "positions": {
        "data": [
          {
            "id": "18ce3121-d89c-4c96-85d4-2ff8d71114c9",
            "type": "form_field_positions"
          },
          {
            "id": "d253fb66-f489-46cf-a62f-d104b18870d3",
            "type": "form_field_positions"
          },
          {
            "id": "17c059bd-bbcb-4f96-8dc5-f076acbffad6",
            "type": "form_field_positions"
          },
          {
            "id": "e3f42d36-0eae-4fa2-93c4-75bbd6a6a439",
            "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