Update a specific form_field by 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": "51a19884-6b86-4f66-bb88-fa5f8dcc6123",
"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": "Qui natus numquam consequatur.",
"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-08-01T09:46:32.382-07:00",
"created_at": "2025-08-01T09:46:28.843-07:00"
},
"relationships": {
"options": {
"data": [
{
"id": "4a650593-357e-4237-93cc-7adf9ae69227",
"type": "form_field_options"
},
{
"id": "8a94fac6-8910-4409-85a6-7611aba6c02d",
"type": "form_field_options"
}
]
},
"positions": {
"data": [
{
"id": "965e80d8-13a7-4b7b-a59b-7b4c57ca5475",
"type": "form_field_positions"
},
{
"id": "dd52f19a-88c2-4a59-aa7f-503eac221936",
"type": "form_field_positions"
},
{
"id": "66586a52-73a6-482b-846f-e43a042b51e6",
"type": "form_field_positions"
},
{
"id": "706e7567-58fc-474e-b23e-bfc6431c7f03",
"type": "form_field_positions"
}
]
}
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
form_field updated
The response is of type object
.
Was this page helpful?
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": "51a19884-6b86-4f66-bb88-fa5f8dcc6123",
"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": "Qui natus numquam consequatur.",
"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-08-01T09:46:32.382-07:00",
"created_at": "2025-08-01T09:46:28.843-07:00"
},
"relationships": {
"options": {
"data": [
{
"id": "4a650593-357e-4237-93cc-7adf9ae69227",
"type": "form_field_options"
},
{
"id": "8a94fac6-8910-4409-85a6-7611aba6c02d",
"type": "form_field_options"
}
]
},
"positions": {
"data": [
{
"id": "965e80d8-13a7-4b7b-a59b-7b4c57ca5475",
"type": "form_field_positions"
},
{
"id": "dd52f19a-88c2-4a59-aa7f-503eac221936",
"type": "form_field_positions"
},
{
"id": "66586a52-73a6-482b-846f-e43a042b51e6",
"type": "form_field_positions"
},
{
"id": "706e7567-58fc-474e-b23e-bfc6431c7f03",
"type": "form_field_positions"
}
]
}
}
}
}