Skip to content
/
Update template

Mailgun API (3.0.0)

Mailgun API defined by OpenAPI Specification (OAS) 3.1.0

Download OpenAPI description
mailgun.json
mailgun.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

https://api.eu.mailgun.net/

Messages

Send email two ways via our REST API:

  1. Send emails using MIME format using a MIME building library
  2. Submit the individual parts (Text, html, attachments, etc.)

Reminder: You can also send email via SMTP with Mailgun. Please reference the user manual.

Operations

Domains

Domains API manages domains, domain keys and DNS verification.

Operations

Domain Keys

An authentication standard used to prevent email spoofing.

Operations

Domain Tracking

Mailgun offers tracking for clicks, unsubscribes, and opens, with optional HTTPS protocol support on tracking URLs. To enable HTTPS, Mailgun uses Let’s Encrypt with HTTP-01 challenges through your existing tracking CNAME record to issue a TLS certificate. This setup also includes support for HTTP Strict Transport Security (HSTS) for enhanced security.

Operations

DKIM Security

Automatic Sender Security DKIM Key APIs. To enable this feature please see 'Update a domain' API docs.

Operations

Webhooks

Webhooks API manages domain's webhooks. You can create, access and delete webhooks programmatically.

Operations

Metrics

The Mailgun Metrics API provides programmatic access to detailed analytics data about your email sending activity. This API allows you to query, filter, and analyze email performance metrics to gain insights into deliverability, engagement, and overall sending health.

Operations

Logs

Mailgun keeps track of every inbound and outbound message event and stores this log data. This data can be queried and filtered to provide insights into the health of your email infrastructure.

Operations

Bounce Classification

Operations

Tags New

Mailgun allows you to tag your email with unique identifiers. Tags are visible via our analytics tags API endpoint.

Operations

Stats

Mailgun collects many different events and generates event statistics which are available in your Control Panel. This data is also available via our stats API endpoint.

WARNING: This API is deprecated in favor of our Metrics API.

Operations

Tags

Mailgun lets you tag each outgoing message with a custom value. When you access stats on your messages, they will be aggregated by these tags.

WARNING: This API is deprecated in favor of our new Tags API.

Operations

Events

Mailgun keeps track of every inbound and outbound message event and stores this data for at least 3 days.

WARNING: This API is deprecated in favor of our Logs API.

Operations

Alerts

Mailgun allows you to get instant notifications on the sending metrics that matter most, configured specifically for your unique business needs and assets. Route these alerts to the channels your team relies on. Stay on top of sending performance without the need to manually monitor.

Operations

Unsubscribe

Unsubscribe list stores email addresses of recipients who unsubscribed from your mailings by clicking a Mailgun generated unsubscribe link.

Operations

Complaints

Email addresses of recipients who marked your messages as a spam (for ESPs that support FBL).

Operations

Bounces

Bounces - Bounce list stores events of delivery failures due to permanent recipient mailbox errors such as non-existent mailbox. Soft bounces (for example, mailbox is full) and other failures (for example, ESP rejects an email because it thinks it is spam) are not added to the list.

Operations

Allowlist

The allowlist API provides the ability to allowlist specific addresses from being added to bounce list. You can allowlist by domain name (i.e example.com) or by specific address (i.e. alice@example.com). Mailgun doesn’t add an address to bounce list if the address is allowlisted. This API is very useful if you test against your private services and don’t want to constantly clean up bounce lists

Operations

Routes

Define a list of routes to handle incoming emails. When a message matches a route expression, Mailgun can forward it on to your application via HTTP or another email address, or store the message temporarily (3 days) for subsequent retrieval.

Operations

Mailing Lists

Programatically create mailing lists.

Operations

Templates

This API allows you to store predefined templates and use them to send messages using the Sending API.

Operations

Get template

Request

Returns metadata information about the stored template specified in the url. If the active flag is provided, the content of the active version of the template is returned. If the version_name flag is provided, version information will be included as well. By default: the version field is not provided. To see available versions other than the active version, use the /versions API instead

Security
basicAuth
Path
domain_namestringrequired

Domain name the template is stored under.

template_namestringrequired

Template name to fetch.

Query
activestring

If this flag is set to yes the active version of the template is included in the response.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v3/{domain_name}/templates/{template_name}?active=string'

Responses

A 200 response

Bodyapplication/json
templategithub.com-mailgun-temple-model-Template (object) or nullrequired

Template details

Any of:

Template details

template.​namestringrequired

Name of the template

template.​descriptionstring

Description of the template

template.​createdAtstringread-only

Creation date in RFC822 format

template.​createdBystring

Indicate who created the template

template.​idstringread-only

Template ID

template.​versiongithub.com-mailgun-temple-model-Version (object) or nullread-only

Active version information

Any of:

Active version information

template.​versionsArray of objects or null(github.com-mailgun-temple-model-Version)read-only

List of template's versions

Response
application/json
{
  "template": {
    "name": "template_name",
    "description": "This is the description of the template",
    "createdAt": "Sat, 12 Nov 1955 06:38:00 UTC",
    "createdBy": "user-supplied-value",
    "id": "46565d87-68b6-4edb-8b3c-34554af4bb77",
    "version": { … }
  }
}

Update template

Request

Update the description of a template.

Security
basicAuth
Path
domain_namestringrequired

Domain name the template is associated with.

template_namestringrequired

The template name.

Bodymultipart/form-datarequired
descriptionstring

Update description of the template being updated.

curl -i -X PUT \
  -u <username>:<password> \
  'https://api.mailgun.net/v3/{domain_name}/templates/{template_name}' \
  -H 'Content-Type: multipart/form-data' \
  -F description=string

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

templateobjectrequired

Template change details

template.​namestringrequired

Name of the template

template.​versiongithub.com-mailgun-temple-httpapi-versionUpdate (object) or null

Template version details

Any of:

Template version details

Response
application/json
{
  "message": "template has been updated",
  "template": {
    "name": "template_name"
  }
}

Delete a template

Request

Delete the template specified in the url. NOTE: This method deletes all versions of the specified template.

Security
basicAuth
Path
domain_namestringrequired

Domain name the template is associated with.

template_namestringrequired

template name to be deleted.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v3/{domain_name}/templates/{template_name}'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

templateobjectrequired

Template change details

template.​namestringrequired

Name of the template

template.​versiongithub.com-mailgun-temple-httpapi-versionUpdate (object) or null

Template version details

Any of:

Template version details

Response
application/json
{
  "message": "template has been deleted",
  "template": {
    "name": "template_name"
  }
}

IP Pools

IP Pools allow you to group your dedicated IPs into customized "pools" to help manage your sending reputation for different mail sending streams.

Operations

Dynamic IP Pools

Dynamic IP Pools allow you to group your dedicated IPs into customized "pools" based on sender reputation. Domains enrolled in Dynamic IP Pools will be assigned to a pool based on the result of periodic health checks.

Operations

IPs

The IP API endpoint allows you to access information regarding the IPs allocated to your Mailgun account that are used for outbound sending.

Operations

IP Address Warmup

Operations

Subaccounts

Mailgun supports the creation, modification, and deletion of subaccounts. A subaccount is a child account of a parent account. The parent account can have multiple subaccounts. The subaccounts are created and managed by the parent account.

Operations

Custom Message Limit

The custom message limit imposes a hard limit on how many messages your account can send during a calendar month.

Operations

Account Management

Perform account-level CRUD operations.

Operations

Keys

The Keys API lets you view and manage API keys.

Operations

Credentials

The Credentials API lets you view and manage SMTP credentials.

Operations

IP Allowlist

The IP Allowlist API lets you view and manage allowlisted IP addresses to which API key and SMTP credential usage is restricted.

Operations

Users

Mailgun API supports viewing user entities.

Operations