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

Api-TokenstringRequired

API token in Api-Token header

Responses

200

OK.

application/json

idintegerOptional

uuidstring · uuidOptional

namestring · max: 255Optional

categorystring · max: 255Optional

subjectstring · max: 255Optional

body_textstring · max: 10000000Optional

body_htmlstring · max: 10000000Optional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

get/api/email_templates

curl -X GET "https://mailtrap.io/api/email_templates" \
  -H "Api-Token: YOUR_API_KEY"

[
  {
    "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

Api-TokenstringRequired

API token in Api-Token header

Body

Responses

201

Email template created successfully.

application/json

idintegerOptional

uuidstring · uuidOptional

namestring · max: 255Optional

categorystring · max: 255Optional

subjectstring · max: 255Optional

body_textstring · max: 10000000Optional

body_htmlstring · max: 10000000Optional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

422

Validation errors

application/json

post/api/email_templates

curl -X POST "https://mailtrap.io/api/email_templates" \
  -H "Api-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email_template": {
      "name": "Welcome Email",
      "subject": "Welcome to {{company_name}}!",
      "category": "onboarding",
      "body_html": "<h1>Welcome {{user_name}}!</h1>",
      "body_text": "Welcome {{user_name}}!"
    }
  }'

{
  "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

Api-TokenstringRequired

API token in Api-Token header

Path parameters

email_template_idinteger · int64Required

Email template ID

Example: 60927

Responses

200

Returns attributes of the email template.

application/json

idintegerOptional

uuidstring · uuidOptional

namestring · max: 255Optional

categorystring · max: 255Optional

subjectstring · max: 255Optional

body_textstring · max: 10000000Optional

body_htmlstring · max: 10000000Optional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

get/api/email_templates/{email_template_id}

curl -X GET "https://mailtrap.io/api/email_templates/{email_template_id}" \
  -H "Api-Token: YOUR_API_KEY"

{
  "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

Api-TokenstringRequired

API token in Api-Token header

Path parameters

email_template_idinteger · int64Required

Email template ID

Example: 60927

Responses

204

No Content

No content

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

delete/api/email_templates/{email_template_id}

curl -X DELETE "https://mailtrap.io/api/email_templates/{email_template_id}" \
  -H "Api-Token: YOUR_API_KEY"

No content

Update Email Template

patch

Update an email template

Authorizations

Api-TokenstringRequired

API token in Api-Token header

Path parameters

email_template_idinteger · int64Required

Email template ID

Example: 60927

Body

Responses

200

Email template updated successfully.

application/json

idintegerOptional

uuidstring · uuidOptional

namestring · max: 255Optional

categorystring · max: 255Optional

subjectstring · max: 255Optional

body_textstring · max: 10000000Optional

body_htmlstring · max: 10000000Optional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

422

Validation errors

application/json

patch/api/email_templates/{email_template_id}

curl -X PATCH "https://mailtrap.io/api/email_templates/{email_template_id}" \
  -H "Api-Token: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email_template": {
      "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"
}

PreviousThreads NextSend Test Emails

Last updated 2 hours ago

Was this helpful?