Mailgun

Cancels a selected job by list ID.

Gets a selected job by list ID.

Starts a V3 list validation job.

Cancels a selected job by list ID.

Gets a selected job by list ID.

Returns all jobs.

Returns all jobs.

Deletes a member from a mailing list

Remove Alert

Delete Slack settings and Slack event settings for the Mailgun account. To revoke the Slack access token, use DELETE /v1/alerts/slack/oauth. To completely remove the Slack App from Slack Workspace, go into App Configuration in Slack.

Revoke Slack access token, delete Slack settings and Slack event settings. NOTE: All Mailgun accounts connected to the same Slack workspace share the same token. To completely remove the Slack App from Slack Workspace, go into App Configuration in Slack.

Deletes the tag for an account

Domain keys are not recoverable after deletion so use with care

Removes any dynamic IP pool override for a domain. The domain's pool assignment will be managed by health checks.

Deletes a single domain from an account

Removes IP from monitoring

Delete a specific accessibility test by its unique test ID. This endpoint allows you to remove an accessibility test from the system. If the test ID does not exist, the appropriate error message is returned.

Deletes all versions of a code analysis test by test ID.

Delete a specific image validation test by its unique test ID. This endpoint allows you to remove an image validation test from the system. If the test ID does not exist, the appropriate error message is returned.

Delete a specific link validation test by its unique test ID. This endpoint allows you to remove a link validation test from the system. If the test ID does not exist, the appropriate error message is returned.

Permanently deletes the spam test and its results.

Delete Mailgun API key

Delete PreviewShare record by TID.

Deletes the specified test.<br><br>**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/DELETE-v2-preview-tests--test-id-)._

Delete a send alert

Delete a limit threshold for an account

Delete account-level webhooks for the authenticated account. You can either delete all webhooks by setting all=true, or specify specific webhook IDs to delete via webhook_ids. If both are provided, the specific webhook_ids will be deleted. Note: Webhook changes can take up to 10 minutes to become effective due to caching.

Delete a specific account-level webhook by its webhook ID. This removes the webhook from all associated event types. Note: Webhook changes can take up to 10 minutes to become effective due to caching.

Delete Mailgun account IP allowlist entry

Deletes the specified test and its content checking. Once it is deleted, it cannot be recovered.

Clears all email addresses with bounces from the domain. Delivery to the deleted email addresses will longer be suppressed.

Delivery to the deleted email address resumes until it bounces again.

Clears all email addresses with complaints from the domain. Delivery to the deleted email addresses will longer be suppressed.

Delivery to the deleted email address resumes until there is another complaint.

Clear all unsubscribe email addresses for the domain. Delivery to the deleted email addresses will no longer be suppressed.

Delivery to the deleted email address resumes until it unsubscribes again.

Delete an entire allowlist for a domain

Remove a single entry from the allowlist

Deletes all scheduled and undelivered mail from the domain queue. This endpoint must be called on the same storage API host as the mail's generated storage URL. e.g. https://storage-us-east4.api.mailgun.net/v3/example.com/envelopes The storage hosts are: `storage-us-east4.api.mailgun.net`, `storage-us-west1.api.mailgun.net`, and `storage-europe-west1.api.mailgun.net`.

Delete all templates and their versions for the domain.

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

Delete a specific template version.

Delete a tag associated with a domain

Delete Mailgun SMTP credentials for a given domain

Delete Mailgun SMTP credentials for a given domain and SMTP user

Remove all url(s) for a specified webhook type.

The domain must not be disabled or used as an authority for an other domain. Sandbox domain can't be deleted.

The behavior of this endpoint depends on the value of the `replacement_ip` and `replacement_pool_id` parameters. One of these parameters (but not both) must be provided. If `replacement_ip` is provided, the IP(s) will be assigned to the domain. `replacement_ip` can include one of the following: * valid IP(s): this IP address or addresses will be added to the domain * string `shared`: if the account is eligible for shared IPs, a suitable shared IP will be chosen and added to the domain The 'replacement_ip' parameter cannot include any IPs that are already assigned to a Dedicated IP Pool or a Dynamic IP Pool. If `replacement_pool_id` is provided, the Dedicated IP Pool will be assigned to the domain.

The behavior of the endpoint depends on the value of the `ip` parameter. It can be one of the following: * a valid IP address: this IP address will be removed from the domain pool. * string `all`: the entire domain pool will be removed. As far as the system is concerned, such domain will no longer exist. * string `ip_pool`: the DIPP which is currently linked to the domain will be unlinked. ### Removing An IP Note that it's impossible to alter domain IPs if a DIPP is linked to the domain. If the account is not eligible for shared IPs, additional rules apply: * removing the last IP from the domain is not allowed; * if all of the remaining dedicated IPs are on warmup, an extra IP might be added to the domain pool. ### Unlinking The DIPP The account must have 'DIPPs' feature enabled. Either `ip` or `pool_id` query parameter must be specified, but not both. If the special value `shared` is used for the replacement IP, the account must be eligible for shared IPs. In this case the system will assign a shared IP as the replacement.

The behavior of the endpoint depends on the value of the `ip` parameter. It can be one of the following: * a valid IP address: this IP address will be removed from the domain pool. * string `all`: the entire domain pool will be removed. As far as the system is concerned, such domain will no longer exist. * string `ip_pool`: the DIPP which is currently linked to the domain will be unlinked. ### Removing An IP Note that it's impossible to alter domain IPs if a DIPP is linked to the domain. If the account is not eligible for shared IPs, additional rules apply: * removing the last IP from the domain is not allowed; * if all of the remaining dedicated IPs are on warmup, an extra IP might be added to the domain pool. ### Unlinking The DIPP The account must have 'DIPPs' feature enabled. Either `ip` or `pool_id` query parameter must be specified, but not both. If the special value `shared` is used for the replacement IP, the account must be eligible for shared IPs. In this case the system will assign a shared IP as the replacement.

Removes all dynamic IP pools from the account. All domains on the account (and subaccounts, if any) must be removed from dynamic IP pools before the pools can be removed. Any standard dedicated IP pools will not be modified.

By default this call is scoped to the entire account. You can scope the request by providing the 'domain.name' query parameter. If the 'domain.name' parameter is provided and the requested rule is not defined for that domain the call will return 404 Not Found

The `DIPPs` feature must be enabled for the account. It is not allowed to delete a DIPP inherited from the parent account. If the DIPP is delegated to subaccounts, those will also be updated. If the replacement DIPP is specified, all domains linked to the deleted DIPP will be relinked to the replacement DIPP. The latter must contain at least one IP. If the replacement IP is specified, all domains linked to the deleted DIPP will be unlinked, and the replacement IP will be assigned to them. It is not allowed to delete a DIPP inherited from the parent account and replace it with an IP (subaccounts do not explicitly manage their IPs). The replacement IP must be a dedicated one; it can't belong to another DIPP. If a special value `shared` is used, appropriate shared IPs will be used (the account must be eligible for shared IPs in this case). Omitting both replacement DIPP and replacement IP is allowed only if the DIPP being deleted contains no IPs. The processing of affected domains and subaccounts happens asynchronously after the endpoint returns a response.

Revokes delegation of a dedicated IP pool (DIPP) from a specified subaccount. The DIPP will no longer be available to the subaccount. Unlike legacy endpoints, this supports accounts with multiple delegated DIPPs. Request parameters are encoded as form data.

The account must have 'DIPPs' feature enabled. It's not allowed to edit a DIPP inherited from the parent account. If the DIPP is linked to domains, the domains will be updated asynchronously (after this endpoint returns response).

Cancels the warmup plan for an IP address. The IP must be dedicated and owned by the account.

The IP must belong to the account. If the `alternative` parameter is present, it is used to replace the removed ip on all domains.

Deletes a mailing list

Remove the rotue from the account.

Deletes a single list health previewk job by ID.

Delete webhook URLs from all event types they are associated with. Supports deleting multiple URLs at once by repeating the `url` query parameter.

Delete the result and all associated information.

Delete the result and all associated information.

Delete a Seed List

Delete all account-level templates and their versions.

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

Delete a specific version of an account-level template.

Delete a custom sending limit

Delete a subaccount

#### Description Initiates the process to revoke a DIPP delegated to a subaccount. All domains linked to the DIPP will be unlinked. This endpoint cannot be used with subaccounts that have multiple inherited DIPPs.

Delete a custom sending limit

Remove an authorized sandbox domain email recipient

Get details about a specific mailing list member

Paginate over list members in a given mailing list in ascending order

Lists members in a given mailing list

The current list of events that you can chose to receive alerts for.

This endpoint returns a list of all configured alert settings for your account.

List Slack channels for the connected Slack workspace.

Returns Slack channel.

Gets the tag limit and current number of unique tags for an account

Deprecated: use POST /v2/bounce-classification/metrics

Deprecated: use GET /v2/bounce-classification/config/groups/{group-id}

Deprecated: use POST /v2/bounce-classification/metrics

Deprecated: use POST /v2/bounce-classification/metrics

Deprecated: use POST /v2/bounce-classification/metrics

Deprecated: use POST /v1/analytics/logs - https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs

Deprecated: use POST /v2/bounce-classification/metrics instead

List domain keys, and optionally filter by signing domain or selector. Results are paginated - use the 'limit' parameter to control page size (default 10, max 100). Use the 'page' parameter from the paging response URLs to navigate through pages.

Retrieves the list of domains that have DMARC monitoring.

Retrieve DMARC reporting data for a domain.

Retrieve DMARC reporting data from a specific source.

Retrieve DMARC reporting data for a hostname.

Retrieve DMARC reporting data for an IP Address.

Retrieves the DMARC DNS records to be used for configuration

Checks if DMARC has been setup for user

Retrieves all domains enrolled in dynamic IP pools across the parent account and subaccounts.

Retrieves a domain's history records

Runs a health check on a domain and returns which pool it would be placed in. It does NOT enroll the domain or set the band

Retrieve history records for all domains assigned to Dynamic IP Pools across the parent and subaccounts.

Will return details on an Mailgun Optimize Domain. If no Domain is provided, then a list of all Mailgun Optimize Domains on an account will be returned.

Lists monitored IP addresses

Get the IP address

Retrieve a paginated list of all accessibility tests that have been submitted. Each test includes details such as its status, the number of checks performed, and, of those checks, how many passes and failures there were. The response is paginated, with a limit of up to 1000 items per page. The total count of records will display in the meta object under the key, 'count'.

Retrieve the details of a specific accessibility test using the provided test ID. This endpoint returns comprehensive details about the test, including metadata and test results.

Returns a paginated list of all code analysis jobs under the account, showing only the latest version of each test. Uses skip/limit pagination and supports filtering by status.

Returns the lookup dictionary containing variants, clients, platforms, application types, support levels, and categories used in code analysis.

Returns the latest version of code analysis test results for a given test ID.

Returns all versions available for a given test ID.

Returns code analysis test results for a specific test ID and version.

Retrieve a paginated list of all image validation tests that have been submitted. The response is paginated, with a limit of up to 1000 items per page. The total count of records will display in the meta object under the key, 'count'.

Returns the results of an image validation test.

Retrieve a list of previous link validation tests based on various filters.

Returns the results of a link validation test.

Returns a paginated list of all spam tests for the account, ordered by created_at desc. Supports filtering by status and region.

Returns the static list of ESPs supported by spam testing, grouped by category (B2C / B2B).

Returns the current state of a spam test. A Retry-After: 10 header is set when the test is still processing.

List Mailgun API keys

List Email Health score and rates grouped by domains/ips/subaccounts/timestamps

Get Email Health score and rates for account and subaccounts

Gets all domains that are being monitored for blocklisting

Get blocklists that the domain is listed in

Get events for a specific domain

Get all events for all domains monitored

Returns PreviewShare record by UUID.

Returns PreviewShare record by TID.

Returns a list of email preview tests.<br><br>**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/GET-v2-preview-tests)._

Returns a list of clients that can perform an email preview.

Returns test info.<br><br>**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/GET-v2-preview-tests--test-id-)._

Gets HTML content of the passed test.

Gets HTML content of the passed test.

Returns the results for the specified email preview test.

Returns a list of all address records for an account. Each address record is for a single address on a single day.

Returns address records for an single address on the account. Each address record is for a single address on a single day.

Returns a list of all addresses for an account

Returns a list of all domain records for an account. Each domain record is for a single domain on a single day.

Returns domain records for a single domain on the account. Each domain record is for a single domain on a single day.

Returns a list of all address records for an account belonging to a specific domain. Each address record is for a single address on a single day.

Returns a list of all domains for an account

Returns the FBL for the account or domain

Returns the FBL for the account or domain

Returns a list of all summary records for an account. Each record is for a single domain's summary and error summary data.

Returns a list of all address summary records for an account. Each record is for a single address's summary data.

Returns a list of all domain summary records for an account. Each record is for a single domain's summary data.

Returns a list of all domain error summary records for an account. Each record is for a single domain's error summary data.

Returns a list of all address summary records for an account. Each record is for a single address's summary data.

Returns a list of all address summary records for an account and a single address

Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type. Deprecated: Use /v2/spamtraps endpoint.

Get a list of domain, ip, subject, From that hit spamtraps, like spamtraps totals but no counts. Deprecated: Use /v2/spamtraps endpoint.

Deprecated: Use /v2/spamtraps endpoint without dimension parameter.

List send alerts

Get a send alert

List account hits

List limit thresholds for an account

Get a limit threshold for an account

Retrieve all account-level webhooks or filter by specific webhook IDs. Returns webhook details including associated event types.

Retrieve a specific account-level webhook by its webhook ID. Returns webhook details including associated event types.

List Mailgun account IP allowlist entries

This call returns a list of Email Tests along with metadata about each test. Email Tests are stored for 90 days. When query parameters are provided, only the tests matching the specified criteria will be returned; otherwise, all available tests are returned. The response structure remains identical in both cases.

Retrieves detailed information about a specific test, including the subject, submission time (in UNIX timestamp format), processing statuses, and any content checking results. The response includes one to three properties containing arrays of clients: completed (clients that have successfully uploaded screenshots), processing (clients that are still being processed by our system), and bounced (clients that were bounced by the destination and cannot be retried). Additionally, the system will automatically requeue screenshots if they remain in processing for more than three minutes.

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.

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

This call returns detailed results for screenshots including their upload locations, send times, completion times, and information about bounces, if any. <test_id> is a test ID returned from test creation or the get test list functions. The <client_id> is required and restricts the returned data exclusively to the specified client. If the client is not present in the test or is invalid, an error will be returned.

Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type.

Get x509 TLS certificate and status

Parses a list of comma separated addresses and optionally perform light weight validation of addresses.

The validation threshold for this account.

Parses a list of comma separated addresses and optionally perform light weight validation of addresses.

A single email address to validate.

The validation threshold for this account.

A single email address to validate.

Gets aggregate counts by country (USA, RUS, etc…)

Gets aggregate counts on devices that triggered events ('tablet', 'phone', 'pc', etc…)

Gets aggregate counts by email service provider

Paginate over a list of bounces for a domain.

Fetch a single bounce event by a given email address.

Paginate a list of complaints for the domain.

Fetch a single complaint records to check if a given address is present in the list of complaints.

Paginate over a list of unsubscribes for domain.

Fetch a single unsubscribe record to check if a given address is present in a list of unsubscribed users.

Paginate over all allowlist records for a domain.

Fetch a single allowlist record to check if a given address or domain is present.

Mailgun tracks every inbound and outbound message event and retains this data for at least 3 days. See [Filter expression](https://documentation.mailgun.com/docs/mailgun/user-manual/events/#filter-expression) for details about filtering expressions

Returns a list of templates for the domain.

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

Returns a paginated list of template versions.

Retrieve the information and content of the specified version of a template.

Gets stat totals for an entire domain

Get a tag associated with a domain

Retrieve stats by tag

Returns a list for a given domain for different event types

List all tags associated with a domain

Get tag limits by domain

List Mailgun SMTP credential metadata for a given domain

Event(s) created from sending an email with Mailgun will contain a `storage.key` to use to retrieve the email.

Get the list of url(s) for a webhook identified by its webhook_name.

Gets a list of country codes scout curently supports

Gets a list of devices scout currently supports

Gets a list of providers scout currently supports

Returns all webhooks for the domain.

Lists all domains that are not already enrolled in dynamic IP pools.

Provides default and scheduled message queue information.

Use to check if open, click and unsubscribe tracking are active/inactive.

Returns the list of IPs belonging to each of the account's Dynamic IP Pools.

By default this endpoint lists all rules defined on the account. You can scope the list of rules by domain by providing the 'domain.name' query parameter.

Retrieve a forward rule by ID

#### Description Lists all dedicated IP pools of the account. For each pool returns its basic properties (name, description, the list of IPs) and indicates whether the pool is linked to any domains and whether it's an inherited one.

`is_linked` in the response indicates whether the DIPP is currently linked to any domains. If it's `true`, `linked_domain` lists those domains.

Returns a paginated list of domains that are linked to the specified dedicated IP pool.

Retrieves a list of in-flight IP warmup statuses for dedicated IP addresses owned by the account. The response includes pagination URLs for navigating through the results.

Retrieves the status of an in-flight IP warmup, which must be a dedicated IP owned by the account.

`assignable_to_pool` in response lists which IPs can be assigned to DIPPs; this field is present only if the account has 'DIPPs' feature enabled. `total_count` contains the number of items returned in `items` (this depends on the filters applied).

This endpoint retrieves the DIPP spillover settings for a specific account.

List IPs belonging to the account and subaccounts. For IPs linked to subaccounts, there will be an additional record returned per subaccount The detailed IP view feature must be enabled for the account.

This endpoint retrieves the DIPP spillover settings for a specific domain.

Get details about account IP

The IP must belong to the account. Matching domains are ordered by increasing id, then the `limit` and `skip` parameters are applied. If the `search` parameter is present, it is used to limit the results to domains whose names match the search query. The search query is split into words by whitespace and punctuation, then the logical OR is applied.

This endpoint remains active for backwards compatibility. Do not use it in new code. Field `shared` in the response is deprecated and should not be used.

A mailing list is a group of members (recipients) which itself has an email address. This address becomes an ID for this mailing list.

Returns the matching mailing list for the given address

Paginate over mailing lists

Get the list of routes. Note that routes are defined globally, per account, not per domain.

Returns a detailed view of the route

Checks if an address matches at least one route.

Gets filtered and group stat totals for an entire account

Gets stat totals for an entire account

Gets stat totals for domains in an account for a single time resolution

A single email address to validate.

All list health preview jobs you have started.

A single list health preview job by ID.

Get the list of domains. Can be filtered by state or authority. Sorting is optional. The list is paginated and limited to 1000 items per page.

List all domain keys for your domain, including active/inactive and valid/invalid ones.

Fetches json representation of a domain that includes details about the domain's state and settings.

List all available email providers.

Get the details for all placement test results.

The attributes that can have values listed (for autocomplete).

For the given attribute list the known values (for autocomplete).

The filters that can be used when querying for results.

Get the details for a single result.

Get the details for a single result.

List Seed Lists

List Available Attributes for Seed Lists

Get List of Values for Seed List Attribute

Get Seed List

Get List of Available Seed List Filters

Get a result by the share ID.

The sharing status of a result.

The sharing status of a result.

Returns a list of account-level templates.

Returns metadata information about the stored account-level template. If the active flag is provided, the content of the active version of the template is returned.

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

Retrieve the information and content of the specified version of an account-level template.

Get webhook signing key saved on the account

Fetch the details of custom sending limit on the account

Fetch all subaccounts

#### Description Lists all subaccounts of the parent account to which the parent account has delegated DIPPs.

Fetch the details of a single subaccount

Fetch the details of custom sending limit on the account

Get webhook signing key saved on the account

Get users on an account

Get one's own user details, requires use of an API key with a `user_id` saved on it, typically of 'web' kind

Get details for a user on the account

Adds and/or removes IPs to/from the specified dynamic IP pool. A given pool is required to have at least 1 IP that is not actively warming. Additionally, a single IP cannot be assigned to multiple dynamic pools.

The account must have 'DIPPs' feature enabled. It's not allowed to edit a DIPP inherited from the parent account. IPs being added to the DIPP must be dedicated ones and belong to the account. If IPs of the DIPP end up modified, and the DIPP is linked to domains, the domains will be updated asynchronously (after this endpoint returns response). Returns an error if the passed parameters won't result in any changes.

This endpoint allows you to set or update the DIPP spillover settings for an account . You can specify the ID of the IP pool that spillover IPs are assigned to. The IP pool must contain at least one fully warmed IP address to be valid. To disable DIPP spillover, set the pool_id to an empty string ("").

This endpoint allows you to set or update the DIPP spillover settings for a specific domain. You can specify the ID of the IP pool that spillover IPs are assigned to. The IP pool must contain at least one fully warmed IP address to be valild. To disable DIPP spillover, set the pool_id to an empty string ("").

#### Description Links and/or unlinks dedicated IPs to/from one or more subaccounts in a single operation. IPs linked to subaccounts can be linked to subaccount domains and placed in subaccount IP pools. The account must have the centralized IP assignment feature enabled. Either subaccount_id (one or more) or all_subaccounts=true must be specified, but not both. When all_subaccounts=true or over 100 subaccounts are specified, the operation is applied to every subaccount asynchronously and the response will contain 'queued' instead of 'success'. Rules for linking an IP: The IP must be a dedicated IP belonging to the parent account. The IP must not be assigned to a Dynamic IP Pool on the parent account. Rules for unlinking an IP: The IP must not be assigned to any IP pools on the subaccount. The IP must not be assigned to any domains on the subaccount. #### Request Schema Request parameters are encoded as form data. Name | Description | Required | Type --- | --- | --- | --- subaccount_id | Id of a subaccount to update (may be specified multiple times). Required unless all_subaccounts is true. | false | string all_subaccounts | When true, applies the operation to all subaccounts of the parent account asynchronously. Cannot be combined with subaccount_id. | false | string link_ip | Dedicated IP address to link to the subaccount (may be specified multiple times) | false | string unlink_ip | Dedicated IP address to unlink from the subaccount (may be specified multiple times) | false | string

Adds multiple members, up to 1000 per call, to a mailing list via CSV file.

Adds multiple members, up to 1000 per call, to a mailing list, using JSON array format. If the request includes more than 100 entries, the mailing list will be updated asynchronously.

Adds a new member to the mailing list. For adding many list members, consider bulk upload endpoints "POST /v3/lists/{list_address}/members.json" or "members.csv".

Sends test message to emails with dummy data.

Use this endpoint to add new alert settings record. This service facilitates notifications (Webhook, Slack, or Email) for both Mailgun Optimize and Send Alert threshold breaches. ### Webhooks This section covers details around consuming alerts via webhooks. If you are familiar with Mailgun Send webhooks (which provide status updates on individual email deliveries), there is a lot of overlapping similarity, however, there are also a few minor nuances to account for. #### Securing Webhooks HMAC is used to verify the integrity as well as the authenticity of received webhooks. To verify the origin of a webhook: 1. Encode the webhook’s entire POST request body with the HMAC algorithm (using your webhook signing key and SHA256 digest mode) 2. Compare the resulting hexdigest to the signature provided in the POST request’s X-Sign header. NOTE: If you’re consuming Mailgun Send webhooks, please note that your Mailgun Send webhook signing key differs from your Alerts webhook signing key. Your Alerts webhook signing keys, used for both Optimize and Send Alert products, are available within the Mailgun Alerts UI. #### Webhook URL Validation When adding or updating a webhook URL for alerts, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned from your endpoint, the request will be rejected and your alert setting will not be saved. We intentionally chose to send a GET request instead of a POST when validating URLs so that your webhook endpoint does not have to account for test requests. Additionally, when a POST request is sent to your webhook URL, if a 2xx is not returned, we will attempt retries via an exponential backoff strategy for up to ~8 hours. If the max retry count is reached, the alert will be disabled and the related alert settings record’s disabled_at field will be populated.

Sends test message to slack channels with dummy data.

Sends test webhook request to specified url with dummy data.

Gets customer event logs for an account

Queries filtered metrics for an account

Gets the list of all tags, or filtered by tag prefix, for an account

Queries filtered usage metrics for an account

Create a domain key. Note that once private keys are created or imported they are never exported. Alternatively, you can import an existing PEM file containing a RSA private key in PKCS #1, ASn.1 DER format. Note, the pem can be passed as a file attachment or as a form-string parameter.

Immediately rotate your DKIM key. This will trigger a rotation even if auto-rotation is disabled on the domain.

Gets referral link to redsift

Add a single domain to an account

Register an IP address

This endpoint allows users to submit an accessibility test for processing. It accepts a set of HTML content, processes it for accessibility issues, and returns a unique job ID for tracking the status of the test. The status of the job will display in the meta object, with a status of 'Processing'.

Create a code analysis test to analyze HTML content for email client feature compatibility.

Creates a new version of an existing code analysis test with incremented version number.

Updates the resolved status of a specific instance within a feature in the latest version of a test.

Create an image validation test.

Create an image validation test with HTML

Optimizes images by test id

Optimizes a single image by test id

Reprocess an image validation test.

Create an image validation test by image upload

Create a link validation test.

Create a link validation test from an HTML input.

Reprocess a link validation test.

Compares link validation test results to the spreadsheet provided as a CSV, XLS or XLSX file.

Initiates an inbox placement test with subject and HTML provided directly in the request body. Returns immediately with status=processing; poll GET using the Retry-After interval.

Create Mailgun API key

Regenerate Mailgun Public API key

Returns or generates an account's email preview address.

Create a shareable link to an email preview test.

Re-generates the uuid and share url, and resets the expiration.

Creates a new email preview test.<br><br>**WARNING:** _This endpoint is deprecated in favor of our [V2 endpoint](https://documentation.mailgun.com/docs/inspect/api-reference/openapi-final/tag/Email-Preview/#tag/Email-Preview/operation/POST-v2-preview-tests)._

Create a send alert for an account

Create a limit threshold for an account

Create account-level webhook URLs to receive Mailgun's POST requests containing event information across all domains in your account. Note: Webhook changes can take up to 10 minutes to become effective due to caching.

Items that have no bounces and no delays(classified_failures_count==0) are not returned.

Add Mailgun account IP allowlist entry

Returns or generates an account's email preview address.

This call creates a new email test and submits it to our system for processing.<br>All requests must contain a subject property and one source property (either html or url). All other properties are optional. In the following table, each property and its default value is shown. <br>If content-checking variables (such as those for link validation, image validation, or accessibility) are set in the body of the request, the endpoint will run content-checking on the email content. <br>The response will include an id property that should be used to request the results or trigger further processes on the email content.<br>For enterprise customers, the response will also include the customer_id and reference_id that were submitted with the test.

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.

Initiates generation of a TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll the status endpoint in `location` field to check for success

Parses a list of comma separated addresses and optionally perform light weight validation of addresses.

Parses a list of comma separated addresses and optionally perform light weight validation of addresses.

A single email address to validate.

A single email address to validate.

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

Import a CSV file containing a list of addresses to add to the bounce list. The CSV file must be 25MB or under and must contain the following column headers: address, code, error, created_at. address is a valid email address. code is error code (optional, default: 550). error is error description (optional, default: empty string). created_at is timestamp of bounce event in RFC2822 format (optional, default: current time)

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

Import a CSV file containing a list of addresses to add to the complaint list. The CSV file must be 25MB or under and can contain the following column headers: address, created_at. address is a valid email address (required). created_at is timestamp of complaint event in RFC2822 format (optional, default: current time)

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

Import a CSV file containing a list of addresses to add to the unsubscribe list. The CSV file must be 25MB or under and can contain the following column headers: address, tags, created_at. address is a valid email address (required). tags is tag to unsubscribe from, use * to unsubscribe an address from all domain's correspondence (optional, default: *). created_at is timestamp of unsubscribe event in RFC2822 format (optional, default: current time)

Add an address or domain to the allowlist table

Import a CSV file containing a list of addresses and/or domains to add to the allowlist. The CSV file must be 25MB or under and must contain the following column headers: address, domain. For each row provide either an address or a domain, but not both - choose one, keep the other blank.

Pass the components of the messages such as To, From, Subject, HTML, text parts, attachments, etc. Mailgun will build a MIME representation of the message and send it. In order to send you must provide one of the following parameters: 'text', 'html', 'amp-html' or 'template'. Important: Send options (parameters starting with o:, h:, v:, or t:) are limited to 16KB total

Build a MIME string yourself using a MIME library and submit it to Mailgun. Important: Send options (parameters starting with o:, h:, v:, or t:) are limited to 16KB total

Store a new template, including its name, description and (optionally) the template content. If the template content is provided, a new version is automatically created and becomes the active version.

Adds a new template version. If the template doesn’t contain any other versions, the first version becomes active. A template can store up to 40 versions.

Begins an asynchronous background job to assign all domains to Dynamic IP Pools. This can also include domains belonging to subaccounts depending on the provided parameters. The Dynamic IP Pools feature must be enabled for the account and the request must come from a parent account user.

Create Mailgun SMTP credentials for a given domain

Resend an email

Create a list of webhook URLs you'd like to receive Mailgun's POST requests containing event information.

Domains enrolled in the Dynamic IP pools feature will be assigned an IP pool based on reputation. The feature must be enabled and configured before enrolling domains.

Any existing IPs in dynamic IP pools will be replaced. All IPs must be dedicated IPs and belong to the account. Additionally, each dynamic IP pool must contain at least 1 IP that is not currently warming.

Adds a given IP to a Dynamic IP Pool. The IP must be dedicated and belong to the account.

### Examples You can add multiple email recipients by including the 'forward.recipient' parameter multiple times up to a maximum of 5. ``` $ curl -X POST https://api.mailgun.net/v3/forwards -F match='[email protected]' -F [email protected] -F [email protected] ``` The `match` parameter can contain a wild card expression ``` $ curl -X POST https://api.mailgun.net/v3/forwards -F match='match*@mg.example.com' -F [email protected] ``` Rules only support `*` or literal characters where `*` matches any sequence of characters. So `a.*@example.com` matches email addresses that start with `a.` not email addresses that start with `a` like a regex match would.

The account must have 'DIPPs' feature enabled. Returns the id of the newly created DIPP.

The account must have 'DIPPs' feature enabled. It is not allowed to modify a DIPP inherited from the parent account. All IPs must be dedicated ones, belong to the account and not belong to any other DIPP. All domains linked to the DIPP will be updated so that their IPs include the newly added addresses. If the DIPP is delegated to subaccounts, those will also be updated. The processing of affected domains and subaccounts happens asynchronously after the endpoint returns a response.

Creates a new warmup plan for an IP address. The IP must be dedicated and owned by the account.

The `Dedicated IP Bands` feature must be enabled for the account. The IP must be a dedicated one belonging to the account.

The IP must belong to the account.

A new IP can be assigned only if billing limits allow that.

Adds a mailing list to the account.

Adds a new route to the account

Validate a full list of addresses.

Start a list health preview job from a list of addresses. We will sample the list and run validations on a small percentage.

Creates a domain for sending emails

Create webhook URLs for multiple event types in a single operation. This v4 endpoint allows associating one URL with multiple webhook event types.

Generate a New Seed List

Create and run a new inbox placement test. Either 'html' or 'template_name' field should be provided. 'variables' are [Template variables](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates), which could be used in html or template. You can use next recipient variables inside Template variables, which will be filled for every seed automatically: %recipient.first_name%, %recipient.last_name%.

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.

Adds a new version to an account-level template. If the template doesn't contain any other versions, the first version becomes active. A template can store up to 40 versions.

Create or regenerate webhook signing key on an account

Resend account activation email to the account owner

Create a subaccount

Disable a subaccount

Enable a subaccount

Add authorized email recipient for a sandbox domain