Skip to content
Mailgun Email API/API Documentation/
/
List send alerts

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

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

List send alerts

Request

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.mailgun.net/v1/thresholds/alerts/send

Responses

A 200 response

Bodyapplication/json
itemsArray of objects(github.com-mailgun-thresholds-api-SendAlertItem)required

List of send alerts.

items[].​idstring

The unique identifier for the alert.

items[].​parent_account_idstring

The parent account ID.

items[].​subaccount_idstring

The subaccount ID this alert belongs to.

items[].​account_groupstring

The group this account belongs to.

items[].​namestringrequired

A user-friendly name for the alert.

items[].​created_atstring(date-time)required

Timestamp of when the alert was created.

items[].​updated_atstring(date-time)

Timestamp of when the alert was last updated.

items[].​last_checkedstring(date-time)

Timestamp of the alert was last checked.

items[].​descriptionstring

A description of what the alert does.

items[].​alert_channelsArray of strings(github.com-mailgun-thresholds-api-AlertChannel)

A list of alert channels to notify.

Items Enum ValueDescription
email

Email

slack

Slack

webhook

Webhook

items[].​filtersArray of objects(github.com-mailgun-thresholds-api-Filter)

A list of filters to apply to the alert.

items[].​metricstringrequired

The metric being monitored.

Enum ValueDescription
hard_bounce_rate

Hard bounce rate

temporary_fail_rate

Temporary fail rate

delivered_rate

Delivery rate

complained_rate

Complaint rate

items[].​comparatorstringrequired

The comparison operator.

Enum ValueDescription
=

Equal

!=

Not equal

<

Less than

<=

Less than or equal

>

Greater than

>=

Greater than or equal

items[].​limitstringrequired

The threshold limit for the alert.

items[].​dimensionstringrequired

The dimension to apply to the metric.

Enum ValueDescription
domain

Sender domain name, e.g. example.com

ip

Sending IP address

ip_pool

IP Pool ID

recipient_provider

Recipient Provider, e.g. Gmail, Other US, etc.

subaccount

Subaccount name

items[].​periodstring

The time period for the metric aggregation in the format of '1h' '1d'.

totalinteger(int64)required

Total number of send alerts.

Response
application/json
{
  "items": [
    { … },
    { … }
  ],
  "total": 2
}

Create a send alert for an account

Request

Security
basicAuth
Bodyapplication/jsonrequired
namestringrequired

A user-friendly name for the alert.

metricstringrequired

The metric being monitored.

Enum ValueDescription
hard_bounce_rate

Hard bounce rate

temporary_fail_rate

Temporary fail rate

delivered_rate

Delivery rate

complained_rate

Complaint rate

comparatorstringrequired

The comparison operator.

Enum ValueDescription
=

Equal

!=

Not equal

<

Less than

<=

Less than or equal

>

Greater than

>=

Greater than or equal

limitstringrequired

The threshold limit for the alert.

dimensionstringrequired

The dimension to apply to the metric.

Enum ValueDescription
domain

Sender domain name, e.g. example.com

ip

Sending IP address

ip_pool

IP Pool ID

recipient_provider

Recipient Provider, e.g. Gmail, Other US, etc.

subaccount

Subaccount name

alert_channelsArray of strings(github.com-mailgun-thresholds-api-AlertChannel)

A list of alert channels to notify.

Items Enum ValueDescription
email

Email

slack

Slack

webhook

Webhook

filtersArray of objects(github.com-mailgun-thresholds-api-Filter)

A list of filters to apply to the alert.

periodstring

The time period for the metric aggregation in the format of '1h' '1d'.

descriptionstring

A description of what the alert does.

curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/thresholds/alerts/send \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "hard bounce rate",
    "metric": "hard_bounce_rate",
    "comparator": "<",
    "limit": ".99",
    "dimension": "subaccount",
    "alert_channels": [
      "email",
      "webhook",
      "slack"
    ],
    "period": "1h"
  }'

Responses

A 200 response

Bodyapplication/json
idstring

The unique identifier for the alert.

parent_account_idstring

The parent account ID.

subaccount_idstring

The subaccount ID this alert belongs to.

account_groupstring

The group this account belongs to.

namestringrequired

A user-friendly name for the alert.

created_atstring(date-time)required

Timestamp of when the alert was created.

updated_atstring(date-time)

Timestamp of when the alert was last updated.

last_checkedstring(date-time)

Timestamp of the alert was last checked.

descriptionstring

A description of what the alert does.

alert_channelsArray of strings(github.com-mailgun-thresholds-api-AlertChannel)

A list of alert channels to notify.

Items Enum ValueDescription
email

Email

slack

Slack

webhook

Webhook

filtersArray of objects(github.com-mailgun-thresholds-api-Filter)

A list of filters to apply to the alert.

metricstringrequired

The metric being monitored.

Enum ValueDescription
hard_bounce_rate

Hard bounce rate

temporary_fail_rate

Temporary fail rate

delivered_rate

Delivery rate

complained_rate

Complaint rate

comparatorstringrequired

The comparison operator.

Enum ValueDescription
=

Equal

!=

Not equal

<

Less than

<=

Less than or equal

>

Greater than

>=

Greater than or equal

limitstringrequired

The threshold limit for the alert.

dimensionstringrequired

The dimension to apply to the metric.

Enum ValueDescription
domain

Sender domain name, e.g. example.com

ip

Sending IP address

ip_pool

IP Pool ID

recipient_provider

Recipient Provider, e.g. Gmail, Other US, etc.

subaccount

Subaccount name

periodstring

The time period for the metric aggregation in the format of '1h' '1d'.

Response
application/json
{
  "id": "915ff385-0a9a-4087-86d5-6727ea7d9b49",
  "parent_account_id": "12345",
  "subaccount_id": "67890",
  "name": "delivery rate",
  "created_at": "2026-02-01T10:30:00Z",
  "updated_at": "2026-02-01T10:30:00Z",
  "last_checked": "2026-02-01T10:30:00Z",
  "alert_channels": [
    "email",
    "webhook",
    "slack"
  ],
  "metric": "delivered_rate",
  "comparator": "<",
  "limit": ".99",
  "dimension": "subaccount",
  "period": "1h"
}

Get a send alert

Request

Security
basicAuth
Path
namestringrequired

Threshold name that identifies this threshold

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/thresholds/alerts/send/{name}'

Responses

A 200 response

Bodyapplication/json
idstring

The unique identifier for the alert.

parent_account_idstring

The parent account ID.

subaccount_idstring

The subaccount ID this alert belongs to.

account_groupstring

The group this account belongs to.

namestringrequired

A user-friendly name for the alert.

created_atstring(date-time)required

Timestamp of when the alert was created.

updated_atstring(date-time)

Timestamp of when the alert was last updated.

last_checkedstring(date-time)

Timestamp of the alert was last checked.

descriptionstring

A description of what the alert does.

alert_channelsArray of strings(github.com-mailgun-thresholds-api-AlertChannel)

A list of alert channels to notify.

Items Enum ValueDescription
email

Email

slack

Slack

webhook

Webhook

filtersArray of objects(github.com-mailgun-thresholds-api-Filter)

A list of filters to apply to the alert.

metricstringrequired

The metric being monitored.

Enum ValueDescription
hard_bounce_rate

Hard bounce rate

temporary_fail_rate

Temporary fail rate

delivered_rate

Delivery rate

complained_rate

Complaint rate

comparatorstringrequired

The comparison operator.

Enum ValueDescription
=

Equal

!=

Not equal

<

Less than

<=

Less than or equal

>

Greater than

>=

Greater than or equal

limitstringrequired

The threshold limit for the alert.

dimensionstringrequired

The dimension to apply to the metric.

Enum ValueDescription
domain

Sender domain name, e.g. example.com

ip

Sending IP address

ip_pool

IP Pool ID

recipient_provider

Recipient Provider, e.g. Gmail, Other US, etc.

subaccount

Subaccount name

periodstring

The time period for the metric aggregation in the format of '1h' '1d'.

Response
application/json
{
  "id": "915ff385-0a9a-4087-86d5-6727ea7d9b49",
  "parent_account_id": "12345",
  "subaccount_id": "67890",
  "name": "delivery rate",
  "created_at": "2026-02-01T10:30:00Z",
  "updated_at": "2026-02-03T14:15:00Z",
  "last_checked": "2026-02-04T16:00:00Z",
  "alert_channels": [
    "email",
    "webhook",
    "slack"
  ],
  "metric": "delivered_rate",
  "comparator": "<",
  "limit": ".99",
  "dimension": "subaccount",
  "period": "1h"
}

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

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