OPopenobserve
Templates

Update alert template

Updates an existing alert notification template. Allows modification of template content, formatting, variable placeholders, and styling options. Changes to templates will apply to all future alert notifications that use this template, providing a centralized way to update notification formats across multiple alerts and destinations.

put/api/{org_id}/alerts/templates/{template_name}

Request

Path parameters

org_idstring required

Organization name

template_namestring required

Template name

Request body

applies_tostring[] nullable

Kinds the template is meant for; [] is every kind. Absent on update keeps the stored list.

bodystring
isDefaultboolean nullable
isPrebuiltboolean

True for system-managed prebuilt templates (those whose name starts with prebuilt_). The public API refuses updates and deletes for these, so the UI should render them as read-only.

kindstring nullable

Template kind: "custom" (default) or "content". Absent on write means "unspecified" — create defaults to custom, update preserves the stored kind (sticky-kind rule, design §6.2).

namestring
titlestring
type'http' | 'email' | 'sns' | 'slack_app'

Response

Success

codeinteger required
error_detailstring nullable
hintstring nullable

One-line guidance on how to fix the error (agent self-correction, D4).

idstring nullable
messagestring required
namestring nullable
suggestionsstring[] nullable

Closest valid alternatives for a mistyped field/function name.

trace_idstring nullable
warningsstring[] nullable

Problems with a request that succeeded anyway. Distinct from hint, which explains a failure: these accompany a 200, and the caller is entitled to have meant it.

Changes

No recorded changes to this operation across all 1 revision of this API.