Email Templates

Delete a custom email template

DELETE/email-templates/{id}
email-templates:writedelete_email_templateDestructiveIdempotent

Deletes a custom template and returns 204. A system template, customised or not, returns 409 invalid_state and is kept: use POST /email-templates/{id}/actions/reset to return it to its default. It emits email_template.deleted. It can't be undone and has no dry run; create the template again with POST /email-templates. Deleting a template that is already deleted returns 404.

Path parameters

  • idstringRequired#

    The template slug, such as user_welcome. It is the template's id. A leading underscore is accepted and ignored.

Responses

204

The template was deleted.

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
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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