v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBIncidents
Update incident notification template
Updates an existing notification template's attributes.
patch/api/v2/incidents/config/notification-templates/{id}
Path parameters
idstring uuid required
Example:00000000-0000-0000-0000-000000000001
The ID of the notification template.
Query parameters
includestring
Example:created_by_user,incident_type
Comma-separated list of relationships to include. Supported values: created_by_user, last_modified_by_user, incident_type
Request body
Example request
{
"data": {
"attributes": {
"category": "update",
"content": "Incident Status Update:\n\nTitle: {{incident.title}}\nNew Status: {{incident.state}}\nSeverity: {{incident.severity}}\nServices: {{incident.services}}\nCommander: {{incident.commander}}\n\nFor more details, visit the incident page.",
"name": "Incident Status Update Template",
"subject": "Incident Update: {{incident.title}} - {{incident.state}}"
},
"id": "00000000-0000-0000-0000-000000000001",
"type": "notification_templates"
}
}Response
OK
Example response
{
"data": {
"attributes": {
"category": "alert",
"content": "An incident has been declared.\n\nTitle: {{incident.title}}\nSeverity: {{incident.severity}}\nAffected Services: {{incident.services}}\nStatus: {{incident.state}}\n\nPlease join the incident channel for updates.",
"created": "2025-01-15T10:30:00Z",
"modified": "2025-01-15T14:45:00Z",
"name": "Incident Alert Template",
"subject": "{{incident.severity}} Incident: {{incident.title}}"
},
"id": "00000000-0000-0000-0000-000000000001",
"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": "notification_templates"
},
"included": [
{
"relationships": {
"org": {
"data": {
"id": "00000000-0000-beef-0000-000000000000",
"type": "orgs"
}
},
"other_orgs": {
"data": []
},
"other_users": {
"data": []
},
"roles": {
"data": [
{
"id": "3653d3c6-0c75-11ea-ad28-fb5701eabc7d",
"type": "roles"
}
]
}
},
"type": "users"
}
]
}