Skip to content
/
Create Export Job for Ema...

Alerts (0.0.1)

Our alerting solution is centered around two concepts: events and channels. The occurrence of an event can be configured to trigger an alert. A channel describes the delivery method for an alert. Every configured alert consists of an event type / channel pair. This level of granularity allows alerting to be configured to your exact preference.

Download OpenAPI description
openapi-final.json
openapi-final.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

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

Domains

Operations

Inbox Placement

Inbox Placement testing allows you to see the likely deliverability of your email campaigns.

Operations

Email Preview

This API provides functionality to create and manage email preview tests, as well as create shareable links.

Operations

Retrieve Export Job Details for Email Preview Test Screenshots

Request

Retrieves the status and details of an export job created to collect screenshots for an Email Preview Test. Provide the test ID to fetch the latest export job information.

Security
basicAuth
Path
test_idstringrequired

Unique identifier of the Email Preview Test

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v2/preview/tests/{test_id}/exports'

Responses

A 200 response

Bodyapplication/json
job_idstringrequired
test_idstringrequired
clientsArray of stringsrequired
job_statusstringrequired
zip_urlstring
failed_clientsArray of strings
errorobject(Email_Preview_API_github.com-mailgun-emailpreview-queue_tracking-APIError)
Response
application/json
{
  "job_id": "67b469d74b911fa30a4d782e",
  "test_id": "98b469d74b956fa30a4d125f",
  "clients": [
    "android11_gmailapp_pixel5_dm",
    "android12_gmailapp_pixel6_dm"
  ],
  "job_status": "Completed",
  "zip_url": "https://example.com/export.zip"
}

Create Export Job for Email Preview Test Screenshots

Request

Initiates an export job that collects screenshots for a specified Email Preview Test. Provide the list of client IDs whose screenshots you want to export. The job status can be monitored using the job ID returned in the response.

Security
basicAuth
Path
test_idstringrequired

Unique identifier of the Email Preview Test to export screenshots for

Bodyapplication/jsonrequired
clientsArray of stringsrequired
test_idstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v2/preview/tests/{test_id}/exports' \
  -H 'Content-Type: application/json' \
  -d '{
    "clients": [
      "android11_gmailapp_pixel5_dm",
      "android12_gmailapp_pixel6_dm"
    ]
  }'

Responses

A 200 response

Bodyapplication/json
job_idstringrequired
test_idstringrequired
clientsArray of stringsrequired
job_statusstringrequired
zip_urlstring
failed_clientsArray of strings
errorobject(Email_Preview_API_github.com-mailgun-emailpreview-queue_tracking-APIError)
Response
application/json
{
  "job_id": "67b469d74b911fa30a4d782e",
  "test_id": "98b469d74b956fa30a4d125f",
  "clients": [
    "android11_gmailapp_pixel5_dm",
    "android12_gmailapp_pixel6_dm"
  ],
  "job_status": "Processing"
}

Create PreviewShare

Request

Create a shareable link to an email preview test.

Security
basicAuth
Bodyapplication/jsonrequired
test_idstringrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/preview/sharing \
  -H 'Content-Type: application/json' \
  -d '{
    "test_id": "some-id"
  }'

Responses

A 200 response

Bodyapplication/json
messagestringrequired
Response
application/json
{
  "message": "record created"
}

Spam Traps Monitoring

Our spam trap monitoring service surfaces how much of your email is being sent to known spam traps.

Operations

Email Health Score

Operations

IP Blocklist Monitoring

Operations

Domain Blocklist Monitoring

Blocklist Monitoring enables you to keep an eye on your reputation. Monitor your domains against our curated list of blocklist providers to make sure you aren't being blocked.

Operations

Google Postmaster Tools

This API provides access to Google Postmaster data.

Operations

Microsoft SNDS

This API provides access to Microsoft SNDS data.

Operations

Alerts

Operations