Templates

Manage email templates

Create and manage reusable email templates with dynamic content.

Get all Email Templates

get

Get all email templates existing in your account

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

account_idintegerRequired

Account ID

Example: 1

Responses

200

OK.

application/json

401

Unauthorized. Check your API credentials.

application/json

403

Forbidden. Verify domain or check permissions.

application/json

get

/api/accounts/{account_id}/email_templates

Node.jsPHPPythonRuby.NETJavacURL

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const templates = await client.templates.getAll();
templates.forEach(tpl => console.log(`${tpl.name}: ${tpl.uuid}`));

[
  {
    "id": 26730,
    "uuid": "018dd5e3-f6d2-7c00-8f9b-e5c3f2d8a132",
    "name": "My Email Template",
    "subject": "Promotional Email",
    "category": "Promotional",
    "body_html": "<div>Template Body</div>",
    "body_text": "Template Body",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  }
]

Create Email Template

post

Create a new email template

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

account_idintegerRequired

Account ID

Example: 1

Body

application/json

Responses

201

Email template created successfully.

application/json

401

Unauthorized. Check your API credentials.

application/json

403

Forbidden. Verify domain or check permissions.

application/json

422

Validation errors

application/json

post

/api/accounts/{account_id}/email_templates

Node.jsPHPPythonRuby.NETJavacURL

import { MailtrapClient } from "mailtrap";
const client = new MailtrapClient({ token: "YOUR_API_TOKEN" });
const template = await client.templates.create({
  name: "Welcome Email",
  subject: "Welcome to {{company_name}}!",
  category: "onboarding",
  body_html: "<h1>Welcome {{user_name}}!</h1>",
  body_text: "Welcome {{user_name}}!"
});
console.log(`Template created: ${template.uuid}`);

{
  "id": 26730,
  "uuid": "018dd5e3-f6d2-7c00-8f9b-e5c3f2d8a132",
  "name": "My Email Template",
  "subject": "Promotional Email",
  "category": "Promotional",
  "body_html": "<div>Template Body</div>",
  "body_text": "Template Body",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

Get Email Template

get

Get an email template by ID

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

account_idintegerRequired

Account ID

Example: 1

email_template_idintegerRequired

Email template ID

Example: 1

Responses

200

Returns attributes of the email template.

application/json

401

Unauthorized. Check your API credentials.

application/json

403

Forbidden. Verify domain or check permissions.

application/json

404

Resource not found

application/json

get

/api/accounts/{account_id}/email_templates/{email_template_id}

Node.jsRubyPHPcURL

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const template = await client.templates.get(templateId);
console.log(`Template: ${template.name} (UUID: ${template.uuid})`);

{
  "id": 26730,
  "uuid": "018dd5e3-f6d2-7c00-8f9b-e5c3f2d8a132",
  "name": "My Email Template",
  "subject": "Promotional Email",
  "category": "Promotional",
  "body_html": "<div>Template Body</div>",
  "body_text": "Template Body",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

Delete Email Template

delete

Delete an email template

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

account_idintegerRequired

Account ID

Example: 1

email_template_idintegerRequired

Email template ID

Example: 1

Responses

204

No Content

401

Unauthorized. Check your API credentials.

application/json

403

Forbidden. Verify domain or check permissions.

application/json

404

Resource not found

application/json

delete

/api/accounts/{account_id}/email_templates/{email_template_id}

Node.jsRubyPHPcURL

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
await client.templates.delete(templateId);

No content

Update Email Template

patch

Update an email template

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

account_idintegerRequired

Account ID

Example: 1

email_template_idintegerRequired

Email template ID

Example: 1

Body

application/json

Responses

200

Email template updated successfully.

application/json

401

Unauthorized. Check your API credentials.

application/json

403

Forbidden. Verify domain or check permissions.

application/json

404

Resource not found

application/json

422

Validation errors

application/json

patch

/api/accounts/{account_id}/email_templates/{email_template_id}

Node.jsRubyPHPcURL

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const template = await client.templates.update(templateId, { name: "Updated Template", subject: "New Subject" });

{
  "id": 26730,
  "uuid": "018dd5e3-f6d2-7c00-8f9b-e5c3f2d8a132",
  "name": "My Email Template",
  "subject": "Promotional Email",
  "category": "Promotional",
  "body_html": "<div>Template Body</div>",
  "body_text": "Template Body",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}