Delete a template

DELETE/v1/templates/{name}API key

Deletes the stored template and its whole version history. This can't be undone. Emails already sent are not affected.

If a built-in template has the same name, sends with that name use the built-in template again from now on. Built-in templates themselves can't be deleted and return 404 template_not_found.

Path parameters

namestringpathrequired

The template name.

Response

namestring

The name of the deleted template.

deletedtrue

Always true.

Errors

Status	Code	When
404	`template_not_found`	No stored template with this name. Built-in templates also return this.

Request

import { Flaresend } from '@flaresend/client';

const flaresend = new Flaresend({
  apiKey: process.env.FLARESEND_API_KEY!,
  baseUrl: 'https://mailer.example.com',
});

await flaresend.templates.remove('order-shipped');

Response

{
  "name": "order-shipped",
  "deleted": true
}

Path parametersCopy Anchor Link

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Path parameters

Response

Errors