v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBIncidents
Update an incident user-defined field
Update an incident user-defined field.
patch/api/v2/incidents/config/user-defined-fields/{field_id}
Path parameters
field_idstring required
Example:00000000-0000-0000-0000-000000000000
The ID of the incident user-defined field.
Query parameters
includestring
Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type".
Request body
Example request
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"ordinal": "1.5",
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "user_defined_field"
}
}Response
OK
Example response
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"created": "2026-03-18T08:40:05.185406Z",
"default_value": "critical",
"display_name": "Root Cause",
"metadata": {
"category": "teams_and_services",
"search_limit_param": "page[size]",
"search_query_param": "filter",
"search_result_path": "$.data[*].attributes.name",
"search_url": "/api/v2/incidents/config/services"
},
"modified": "2026-03-18T08:40:05.185406Z",
"name": "root_cause",
"ordinal": "1.5",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
}
},
"type": "user_defined_field"
}
}