Skip to content
Unsubscribe
/
View all unsubscribes

Mailgun API (0.0.0)

Mailgun API defined by OpenAPI Specification (OAS) 3.1.0

Download OpenAPI description
openapi-final.json
openapi-final.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

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

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

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

Unsubscribe

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

Operations

Clear a given unsubscribe event

Request

The delivery to the deleted email address resumes until it unsubscribes again.

Security
basicAuth
Path
domainIDstringrequired

The id of the domain you want to delete a unsubscribe from

addressstringrequired

The address to remove

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v3/{domainID}/unsubscribes/{address}'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

addressstringrequired

Email address

Response
application/json
{
  "message": "Unsubscribe event has been removed",
  "address": "foo@bar.com"
}

View all unsubscribes

Request

Paginate over a list of unsubscribes for a domain.

Security
basicAuth
Path
domainIDstringrequired

The name of the domain you want to get unsubscribes from

Query
limitinteger

Maximum number of records to return (optional, default: 100, max: 1000)

pagestring

Page direction relative to the above address, can be next, previous or last, if empty, returns the first page

addressstringrequired

address serving as a "divider" between pages

termstringrequired

Filter records based on addresses that start with the specified substring.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v3/{domainID}/unsubscribes?limit=0&page=string&address=string&term=string'

Responses

A 200 response

Bodyapplication/json
itemsArray of objects(github.com-mailgun-blackbook-model-Unsubscribe)required
items[].​addressstringrequired

Email address for the original recipient

items[].​tagsArray of stringsrequired

Any tags present on the message the user clicked Unsubscribe on

items[].​created_atobjectrequired

Timestamp for when the unsubscribe request was received in RFC822 format

pagingobject(github.com-mailgun-scaffold-httpapi-paging-PagingResponse)required
paging.​previousstringrequired

Previous page URL

paging.​firststringrequired

First page URL

paging.​nextstringrequired

Next page URL

paging.​laststringrequired

Last page URL

Response
application/json
{
  "items": [
    { … }
  ],
  "paging": {
    "previous": "<previous page url>",
    "first": "<first page url>",
    "next": "<next page url>",
    "last": "<last page url>"
  }
}

Insert unsubscribe records to the unsubscribe list

Request

Request body is expected to be a valid JSON encoded sting containing up to 1000 unsubscribe records or a single unsubscribe record as application/form-data

Security
basicAuth
Path
domainIDstringrequired

The id of the domain you want to insert unsubscribes

Headers
Content-Typestringrequired

Content-Type must be application/json if inserting using JSON, no header necessary for form-data insertion

Body
requiredArray [
addressstringrequired

Email address for the original recipient

tagsArray of stringsrequired

Any tags present on the message the user clicked Unsubscribe on

created_atobjectrequired

Timestamp for when the unsubscribe request was received in RFC822 format

]
curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v3/{domainID}/unsubscribes' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "address": "alice@example.com",
      "tags": [
        "some tag"
      ],
      "createdat": "Thu, 01 May 2025 15:36:42 UTC"
    },
    {
      "address": "bob@example.com",
      "tags": [
        "*"
      ],
      "createdat": "Mon, 01 Jan 0001 00:00:00 UTC"
    },
    {
      "address": "carol@example.com",
      "tags": [],
      "createdat": "Mon, 01 Jan 0001 00:00:00 UTC"
    }
  ]'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "4 addresses have been added to the unsubscribes table"
}

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

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. Health checks are performed on domains and assigned to the appropriate Dynamic Pool.

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