Skip to main content
ZStack
Alerting & Response/Alert Templates

UpdateAlertTemplate

Update a message template name and content

PUT/api/v1/alerting/templates/{templateId}

Operation ID

UpdateAlertTemplate

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • templateId
    StringRequired

    Template identifier to update

Body Fields

  • name
    String

    New template name

    Example: Updated Template

  • content
    String

    New template content

    Example: # Updated: {{.AlertName}}

  • alarmType
    String

    Template dataset type; omitted preserves the existing type; conversion between resource and event is forbidden

    Example: event

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Stable UUID of the template. Builtin templates use fixed UUIDs.

    Example: e6e3e618-7e8e-4df3-843b-227a49ed170b

  • name
    String

    Human-readable template name. Builtin names follow Accept-Language; custom names are preserved.

    Example: Default Email Template

  • format
    String

    Template format: markdown, html, json, or plain_text

    Example: markdown

  • content
    String

    Template content with variable placeholders

    Example: # Alert: {{.AlertName}}

  • source
    String

    Template source: builtin or custom

    Example: builtin

  • createDate
    String

    Timestamp when the template was created

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Timestamp of the last template modification

    Example: 2026-01-15T08:00:00Z

  • alarmType
    String

    Template dataset type: resource or event; independent of builtin/custom source

    Example: event

Change History

View all change history

  • Change Time

    AddedRequest body fields alarmTypeAddedResponse fields alarmType
    View API