Skip to content
/
Delete all account-level...

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

Account Webhooks

Webhooks API to manage account-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. Account-level webhooks are configured independently for US and EU regions. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends.

Operations

Domain Webhooks

Webhooks API to manage domain-specific webhooks. You can create, retrieve, update, and delete webhooks programmatically. When triggered, webhook URLs are deduplicated by event type, across account and domain levels to prevent redundant webhook sends.

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. Using this logs API, 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

Send 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

Alerts

Operations

Limits

Mailgun allows you to set limits on your subaccounts to help you manage usage and costs. You can create, update, retrieve, and delete limits for various pre-send features such as email previews and email validations.

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

Account Templates

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

Operations

Create an account-level template

Request

Store a new account-level template that is available across all domains for the account. Include the template name, description and (optionally) the template content. If the template content is provided, a new version is automatically created and becomes the active version.

Security
basicAuth
Bodymultipart/form-datarequired
namestringrequired

Name of the template being stored. Supports utf-8 characters and name will be down cased.

descriptionstring

Description of the template being stored

createdBystring

Optional metadata field api user can indicate who created the template.

templatestring

Content of the template.

tagstring

Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value initial is used.

commentstring

Version comment. This is valid only if a new version is being created. (template parameter is provided.)

headersstring

Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names From, Subject, and Reply-To are the only ones currently supported.

curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v4/templates \
  -H 'Content-Type: multipart/form-data' \
  -F name=string \
  -F description=string \
  -F createdBy=string \
  -F template=string \
  -F tag=string \
  -F comment=string \
  -F headers=string

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

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.​domainstring

Domain of the template

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
{
  "message": "template has been stored",
  "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",
    "domain": "header.tld",
    "version": { … }
  }
}

Delete all account-level templates

Request

Delete all account-level templates and their versions.

Security
basicAuth
curl -i -X DELETE \
  -u <username>:<password> \
  https://api.mailgun.net/v4/templates

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "templates have been deleted"
}

Get all account-level template versions

Request

Returns a paginated list of versions for an account-level template.

Security
basicAuth
Path
template_namestringrequired

Template name to fetch the versions for.

Query
pagestring

Name of the page to retrieve. Value can be first, last, next, or previous. Defaults to first.

Enum ValueDescription
first

Get the first list's page

last

Get the last list's page

next

Get the next list's page

previous

Get the previous list's page

limitinteger

Number of versions to retrieve. Default and max limit is 100.

pstring

Pivot used to retrieve the next page of versions.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v4/templates/{template_name}/versions?page=first&limit=0&p=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.​domainstring

Domain of the template

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

pagingobjectrequired

Pagination details

paging.​previousstringrequired

Previous page URL

paging.​firststringrequired

First page URL

paging.​nextstringrequired

Next page URL

paging.​laststringrequired

Last page URL

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",
    "domain": "example.com",
    "versions": [ … ]
  },
  "paging": {
    "previous": "https://api.mailgun.net/v4/templates/my-template/versions?page=previous&p=v0&limit=10",
    "first": "https://api.mailgun.net/v4/templates/my-template/versions?limit=10",
    "next": "https://api.mailgun.net/v4/templates/my-template/versions?page=next&p=v1&limit=10",
    "last": "https://api.mailgun.net/v4/templates/my-template/versions?page=last&limit=10"
  }
}

Domain Templates

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

Operations

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