Email Templates

Reset every customised email template

POST/email-templates/actions/reset
email-templates:writereset_email_templatesDestructive

Resets every customised system template and returns { "data": { "reset": n } }, the number reset, which is 0 when none were customised. Each one starts customised and ends default, losing its stored content, subject and switches. Custom and default templates are left alone. Use POST /email-templates/{id}/actions/reset for one. It emits email_template.reset per template. It can't be undone: save the content again with PATCH /email-templates/{id}. dry_run returns the count without resetting.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, optional

{}

Responses

200

The templates were reset.

{
  "data": {
    "reset": 2
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/email-templates/actions/reset\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{}'