Skip to main content

Mailgun

Mailgun is an email delivery service for sending, receiving, and tracking email through an API. The Mailgun connector reads domains, DKIM keys, message events and logs, metrics, tags, suppression lists, webhooks, routes, mailing lists, templates, IPs and IP pools, alerts and sending limits, users, and subaccounts, and can send email and create, update, and delete most of those objects.

Mailgun icon

Power end-to-end data operations for your Mailgun API with Nexla. Our bi-directional Mailgun connector is purpose-built for Mailgun, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Mailgun or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Mailgun workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to the Mailgun API with a Mailgun private API key. To create one:

  1. Sign in to Mailgun at app.mailgun.com.

  2. Open the API Security page of your account settings, and create a private API key. Copy the key when Mailgun shows it, and store it somewhere safe.

  3. Note your account's region. Use the base URL https://api.mailgun.net for an account in the US region, or https://api.eu.mailgun.net for an account in the EU region. Requests to the other region's URL fail.

Mailgun's API uses HTTP Basic authentication with the username api and the API key as the password. You enter only the key: Nexla sends the username api for you. For details, see Mailgun's authentication guide.

The key has full access to the account, including sending email and deleting data, so treat it like a password. Domain sending keys, which only send mail for one domain, don't work with most templates on this page.

Some destinations send email or change your account

Destinations take effect as soon as they are activated, once for each record. Templates that send email are marked Sends email below: Send Email Message, Resend Stored Message, Send Test Alert Email, Add Sandbox Authorized Recipient, and Resend Activation Email. Templates that delete data or change suppression lists, IP assignments, or other account settings in ways that can't be undone from Nexla are marked Side effect. Test with your own addresses first, or with a sandbox domain, which delivers only to authorized recipients.

Delete API Key can revoke the API key that your Nexla credential uses. If it does, every Mailgun source and destination that uses the credential stops working until you create a new key and update the credential.

Some features depend on your Mailgun plan

IP pools, dynamic IP pools, dedicated IPs and IP warmups, subaccounts, and alerts, send alerts, and limit thresholds are available only on some Mailgun plans. On a plan without the feature, Mailgun rejects the request, usually with HTTP 403 or 404.

Authenticate​

Credentials required​

HTTP Basic Authentication with username 'api' and your Mailgun private API key as the password.

FieldRequiredSecretDescription
API KeyYesYesYour Mailgun private API key (API Security in the Mailgun dashboard).
Base URLYesNoThe base URL for the Mailgun API. Use https://api.mailgun.net for US region or https://api.eu.mailgun.net for EU region.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Paste your Mailgun private API key from Prerequisites into the API Key field. Nexla sends it as the Basic authentication password, with the username api, on every request.

  4. Enter the Base URL for your account's region: https://api.mailgun.net (US, the default) or https://api.eu.mailgun.net (EU).

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by listing the account's domains.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Mailgun connector tile, then select the credential that will be used to connect to Mailgun, and click Next; or, create a new Mailgun credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Mailgun endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by area.

Templates that say "Results are paged automatically" read every page; all other templates make a single request. List templates return one record per item, such as one record per domain or event. Templates that need a value, such as a domain name, template name, or ID, read data for that one object; use the matching list template to find the value. Domain-level templates, such as suppressions, events, and domain templates, read one sending domain at a time, so create one source per domain.

Domains​

List Domains (v4)

Lists the account's sending domains (v4 API) with state, type and settings.

  • Results are paged automatically, 1000 records per page.
  • See the Mailgun API reference for the response fields.

List Domains

Returns a list of all domains configured in your Mailgun account.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Domain

Retrieves details for a specific sending domain by name.

  • Enter the Domain Name. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

Get Domain Tracking Settings

Gets a domain's open, click and unsubscribe tracking settings.

  • Enter the Domain. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

Get Domain Sending Queues

Gets the status of a domain's regular and scheduled message queues (disabled or not, and why).

  • Enter the Domain. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

Get Tracking Certificate Status

Gets the status and PEM certificate of a domain's HTTPS tracking certificate.

  • Enter the Domain. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

List Domain DKIM Keys

Lists the DKIM keys of one signing domain with selector, active flag and DNS record.

  • Enter the Signing Domain. Use List DKIM Keys (All Domains) to find it.
  • See the Mailgun API reference for the response fields.

List DKIM Keys (All Domains)

Lists the DKIM keys of all domains with selector and DNS record status.

Messages, events, and logs​

List Domain Events

Lists a domain's message events (accepted, delivered, failed, opened, clicked, ...), newest first.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Results are paged automatically, 300 records per page.
  • See the Mailgun API reference for the response fields.

List Events

Returns a list of events (e.g., deliveries, bounces, complaints) for your Mailgun account.

List Logs

Reads the latest 100 message log entries (events) of the account for the given duration, newest first.

  • Enter the Duration: a period such as 1d, 7d, or 30d (default 1d).
  • Nexla reads this data with a POST request; the request only queries data and changes nothing in Mailgun.
  • See the Mailgun API reference for the response fields.

Get Stored Message

Gets a stored message (kept up to 3 days) by its storage key: headers, body parts and attachments metadata.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Storage Key. Find it in the storage.key field of a stored message's event in List Domain Events.
  • See the Mailgun API reference for the response fields.

Metrics and tags​

Query Email Metrics

Reads the account's daily email metrics for the given duration: accepted, delivered, opened, clicked, unsubscribed, complained, and failed counts, with permanent and temporary failures counted separately. Returns one record per day.

  • Enter the Duration: a look-back period ending now, such as 1d, 7d, or 30d (default 30d).
  • Nexla reads this data with a POST request; the request only queries data and changes nothing in Mailgun.
  • See the Mailgun API reference for the response fields.

Query Usage Metrics

Reads account usage counts (validations, previews, processed messages, and more) per time bucket for the given duration and resolution.

  • Enter the Duration: a period such as 1d, 7d, or 30d (default 30d).
  • Enter the Resolution: hour, day, or month (default day).
  • Nexla reads this data with a POST request; the request only queries data and changes nothing in Mailgun.
  • See the Mailgun API reference for the response fields.

Query Bounce Classification

Reads bounce and delay counts and rates by bounce category and domain for the given duration.

  • Enter the Duration: a period such as 1d, 7d, or 30d (default 168h).
  • Nexla reads this data with a POST request; the request only queries data and changes nothing in Mailgun.
  • See the Mailgun API reference for the response fields.

List Tags

Lists the account's tags (first 1000) with description and first/last seen dates.

  • Nexla reads this data with a POST request; the request only queries data and changes nothing in Mailgun.
  • See the Mailgun API reference for the response fields.

Get Tag Limits

Gets the account's tag limit, current tag count and whether the limit is reached.

Suppressions​

List Bounces

Returns a list of permanent delivery failures (bounces) for a given domain.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Results are paged automatically, 1000 records per page.
  • See the Mailgun API reference for the response fields.

Get Bounce

Looks up one bounced address on a domain: error code, message and date.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Email Address.
  • See the Mailgun API reference for the response fields.

List Unsubscribes

Returns a list of addresses that have unsubscribed from your mailing list for a given domain.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Results are paged automatically, 1000 records per page.
  • See the Mailgun API reference for the response fields.

Get Unsubscribe

Looks up one unsubscribed address on a domain with its tags and date.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Email Address.
  • See the Mailgun API reference for the response fields.

List Complaints

Returns a list of email addresses that have filed spam complaints against your domain.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Results are paged automatically, 1000 records per page.
  • See the Mailgun API reference for the response fields.

Get Complaint

Looks up one address that complained (marked spam) on a domain.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Email Address.
  • See the Mailgun API reference for the response fields.

List Allowlist

Lists a domain's allowlist entries (addresses and domains never added to bounces).

  • Enter the Domain. Use List Domains (v4) to find it.
  • Results are paged automatically, 1000 records per page.
  • See the Mailgun API reference for the response fields.

Get Allowlist Entry

Looks up one allowlist entry (address or domain) on a domain.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Allowlist Value. Use List Allowlist to find it.
  • See the Mailgun API reference for the response fields.

Webhooks​

List Webhooks

Retrieves all account-level webhooks configured in Mailgun, one record per webhook.

Get Account Webhook

Gets one account-level webhook: URL, event types, description, created date.

  • Enter the Webhook ID. Use List Webhooks to find it.
  • See the Mailgun API reference for the response fields.

List Domain Webhooks

Lists a domain's webhook URLs per event type (accepted, delivered, opened, clicked, failed, ...).

  • Enter the Domain. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

Get Domain Webhook

Gets the URLs of one domain webhook event type (e.g. delivered, opened, permanent_fail).

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Webhook Event Type: an event type such as delivered, opened, clicked, or permanent_fail.
  • See the Mailgun API reference for the response fields.

Routes and forwards​

List Routes

Returns all routes defined in your Mailgun account for handling incoming email, one record per route.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Route

Retrieves details for a specific Mailgun inbound email routing rule by ID.

Match Route

Gets the inbound route that matches a recipient address, if any.

List Forward Rules

Lists the account's inbound forward rules (match, forward URLs and recipients).

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Forward Rule

Gets one inbound forward rule by ID.

  • Enter the Forward Rule ID. Use List Forward Rules to find it.
  • See the Mailgun API reference for the response fields.

Mailing lists​

List Mailing Lists (Paged)

Lists the account's mailing lists with member counts.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

List Mailing Lists

Returns a list of all mailing lists configured in your Mailgun account.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Mailing List

Gets one mailing list by address: name, description, access level, member count.

  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • See the Mailgun API reference for the response fields.

List Mailing List Members (Paged)

Lists the members of a mailing list with vars and subscribed flag.

  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

List Mailing List Members

Returns a list of members in a specific Mailgun mailing list.

  • Enter the List Address. Use List Mailing Lists (Paged) to find it.
  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Mailing List Member

Gets one member of a mailing list: name, vars, subscribed.

  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • Enter the Member Address. Use List Mailing List Members (Paged) to find it.
  • See the Mailgun API reference for the response fields.

Templates​

List Domain Templates

Lists a domain's stored email templates.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Domain Template

Gets one domain template with its active version.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • See the Mailgun API reference for the response fields.

List Domain Template Versions

Lists the versions of one domain template.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Domain Template Version

Gets one version of a domain template with its content.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Enter the Version Tag. Use List Domain Template Versions to find it.
  • See the Mailgun API reference for the response fields.

List Account Templates

Lists the account-level email templates.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Account Template

Gets one account-level template with its active version.

  • Enter the Template Name. Use List Account Templates to find it.
  • See the Mailgun API reference for the response fields.

List Account Template Versions

Lists the versions of one account-level template.

  • Enter the Template Name. Use List Account Templates to find it.
  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Account Template Version

Gets one version of an account-level template with its content.

  • Enter the Template Name. Use List Account Templates to find it.
  • Enter the Version Tag. Use List Account Template Versions to find it.
  • See the Mailgun API reference for the response fields.

IPs and IP pools​

List IPs

Lists the account's IP addresses, one record per IP with the address and whether it is dedicated, enabled, and warming up.

List IP Details

Lists the account's IPs in detail (pool, domains, warmup, band).

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get IP

Gets one account IP: dedicated flag and reverse DNS.

  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • See the Mailgun API reference for the response fields.

List IP Domains

Lists the account domains an IP is assigned to.

  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get Available IP Count

Gets how many dedicated and shared IPs the billing plan still allows you to add.

List IP Pools

Lists the account's dedicated IP pools (DIPPs) with their IPs and linked domains.

Get IP Pool

Gets one dedicated IP pool: name, description, IPs and linked domains.

  • Enter the IP Pool ID. Use List IP Pools to find it.
  • See the Mailgun API reference for the response fields.

List IP Pool Domains

Lists the domains linked to a dedicated IP pool.

  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Results are paged automatically, 500 records per page.
  • See the Mailgun API reference for the response fields.

List Delegated IP Pools

Lists the dedicated IP pools delegated to subaccounts.

Get Account Spillover Pool

Gets the dedicated IP pool the account uses for IP spillover.

Get Domain Spillover Pool

Gets the dedicated IP pool a domain uses for IP spillover.

  • Enter the Domain. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

List IP Warmups

Lists the in-flight IP warmups with stage, throttle and volume limit.

Get IP Warmup

Gets the warmup plan of one IP: stage, limits, throttle and stage history.

  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • See the Mailgun API reference for the response fields.

Dynamic IP pools​

List Dynamic IP Pools

Lists the account's dynamic IP pools with their IPs.

List Domains Assignable to Dynamic Pools

Lists the domains that can be enrolled in dynamic IP pools.

List Dynamic Pool Domains

Lists the domains assigned to dynamic IP pools with their pool and override.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Preview Dynamic Pool Assignment

Previews which dynamic IP pool a domain would be assigned to, with the metrics that decide it.

  • Enter the Domain. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

List Domain Dynamic Pool History

Lists a domain's dynamic IP pool band changes with reason and metrics.

  • Enter the Domain. Use List Domains (v4) to find it.
  • See the Mailgun API reference for the response fields.

List Dynamic Pool History

Lists the account's dynamic IP pool band changes across domains.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Alerts and limits​

List Send Alerts

Lists the account's send alerts (metric thresholds that notify you).

Get Send Alert

Gets one send alert by name: metric, comparator, limit, period and filters.

  • Enter the Send Alert Name. Use List Send Alerts to find it.
  • See the Mailgun API reference for the response fields.

List Limit Thresholds

Lists the account's limit thresholds with current count and limit.

Get Limit Threshold

Gets one limit threshold by name with its current count.

  • Enter the Limit Threshold Name. Use List Limit Thresholds to find it.
  • See the Mailgun API reference for the response fields.

List Limits (v2)

Lists the sending limits set for the account or subaccount, per metric.

Get Limit (v2)

Gets the limit set for one metric (404 if none).

Get Primary Limit Warning Settings

Gets the parent account's limit warning settings.

List Threshold Hits

Lists the times the account's alerts and limits were hit.

List Alert Event Types

Lists the event types alerts can be set up for, with descriptions.

List Slack Channels

Lists the Slack channels alerts can be sent to (needs Slack connected).

Get Slack Channel

Gets one Slack channel alerts can be sent to, by channel ID.

  • Enter the Slack Channel ID. Use List Slack Channels to find it.
  • See the Mailgun API reference for the response fields.

Get Account Sending Limit

Gets the account's custom monthly sending limit and current usage.

Account, users, and keys​

Get Current User

Gets the user that owns the API key in use.

List Users

Lists the users of the account with role and status.

  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

Get User

Gets one user of the account: name, email, role, status.

List Subaccounts

Lists the account's subaccounts with status and features.

  • Results are paged automatically, 1000 records per page.
  • See the Mailgun API reference for the response fields.

Get Subaccount

Gets one subaccount: name, status, features and dates.

  • Enter the Subaccount ID. Use List Subaccounts to find it.
  • See the Mailgun API reference for the response fields.

Get Subaccount Sending Limit

Gets a subaccount's custom monthly sending limit and current usage.

  • Enter the Subaccount ID. Use List Subaccounts to find it.
  • See the Mailgun API reference for the response fields.

List API Keys

Lists the account's API keys metadata (id, kind, role, domain, expiry). The secret is not returned.

List SMTP Credentials

Lists a domain's SMTP credential logins with creation date (no passwords).

  • Enter the Domain. Use List Domains (v4) to find it.
  • Results are paged automatically, 100 records per page.
  • See the Mailgun API reference for the response fields.

List IP Allowlist

Lists the account's API IP allowlist entries with descriptions.

List Sandbox Authorized Recipients

Lists the addresses authorized to receive mail from the sandbox domain, with activation status.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Mailgun data sources can also be manually configured to ingest data from any valid Mailgun API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or optional filters that the templates do not send, such as event filters or date ranges. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers. Mailgun endpoint URLs start with your region's base URL, such as https://api.mailgun.net/v3/.... Many Mailgun list responses return the next page's URL in paging.next. See the Mailgun API reference for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Mailgun data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Mailgun destination, and select the Send to Destination option from the menu. Select the Mailgun connector from the list of available destination connectors, then select the credential that will be used to connect to Mailgun, and click Next; or, create a new Mailgun credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Mailgun endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each template sends one request for each record in the Nexset. Templates send the record in one of three ways, and each template below says which:

  • JSON: the record is the JSON body of the request.
  • Form fields: the record's fields are sent as URL-encoded form fields. Mailgun documents most of these fields as multipart/form-data; Nexla sends the same fields URL-encoded. A form field can hold only one value per record, so send a field with several values, such as several to recipients, o:tag tags, or webhook event_types, as one comma-separated string, such as delivered,opened.
  • No body: the record's content is not sent; the request is defined entirely by the template's settings, so send a single record.

Settings such as a domain, template name, or ID are fixed on the destination and apply to every record it sends. Templates are marked Sends email when they cause Mailgun to send email, and Side effect when they delete data, change suppression lists, or make other changes that cannot be undone from Nexla.

Sending email​

Send Email Message

Sends one email for each record through the sending domain set on the destination. Each record holds the message fields, such as from, to, subject, and text or html.

  • Sends email: sends one email for each record to the record's recipients.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as the JSON body of one request.
  • Mailgun documents this request as form data (multipart/form-data), not JSON, and may reject a JSON body. Test with a single record first.
  • See the Mailgun API reference for the request fields.

Resend Stored Message

Resends a stored message to new recipients. Each record (form fields) holds to, the new recipients.

  • Sends email: sends the stored message again, to the recipients in the record.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Storage Key. Find it in the storage.key field of a stored message's event in List Domain Events.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Scheduled Messages

Deletes all scheduled and undelivered mail in a domain's queues.

  • Side effect: permanently deletes the queued messages; they are never sent.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Domains and tracking​

Create Domain

Adds a new sending domain to the account for each record. Each record holds the domain settings, such as name.

  • Each record is sent as the JSON body of one request.
  • Mailgun documents this request as form data (multipart/form-data), not JSON, and may reject a JSON body. Test with a single record first.
  • See the Mailgun API reference for the request fields.

Update Domain

Updates a domain's settings with each record (form fields, e.g. spam_action, web_scheme, wildcard, require_tls, message_ttl).

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Verify Domain

Checks a domain's DNS records again and updates its state.

  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Domain

Deletes the sending domain set on the destination.

  • Side effect: deletes the domain and its settings from the account; Mailgun stops sending and receiving mail for it.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • Nexla sends the request to /v4/domains/{domain}. Mailgun's API reference documents deleting a domain only at /v3/domains/{name}, so check the result in Mailgun after the first run.
  • See the Mailgun API reference for the request fields.

Update Click Tracking

Sets a domain's click tracking with each record (form fields): {"active": "yes"|"no"|"htmlonly"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Open Tracking

Sets a domain's open tracking with each record (form fields): {"active": "yes"|"no", "place_at_the_top"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Unsubscribe Tracking

Sets a domain's unsubscribe link tracking with each record (form fields): {"active", "html_footer", "text_footer"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Generate Tracking Certificate

Generates an HTTPS tracking certificate for a domain's tracking hostname.

  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Regenerate Tracking Certificate

Regenerates an expired HTTPS tracking certificate for a domain.

  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

DKIM keys​

Create DKIM Key

Creates a DKIM key from each record (form fields): {"signing_domain", "selector", "bits"} (optional "pem" to import a key).

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Activate DKIM Key

Activates a domain's DKIM key (selector in the URL) for signing.

  • Enter the Signing Domain. Use List DKIM Keys (All Domains) to find it.
  • Enter the DKIM Selector. Use List DKIM Keys (All Domains) or List Domain DKIM Keys to find it.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Deactivate DKIM Key

Deactivates a domain's DKIM key.

  • Side effect: Mailgun stops signing the domain's mail with this key.
  • Enter the Signing Domain. Use List DKIM Keys (All Domains) to find it.
  • Enter the DKIM Selector. Use List DKIM Keys (All Domains) or List Domain DKIM Keys to find it.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete DKIM Key

Deletes a DKIM key, chosen by signing domain and selector.

  • Side effect: mail is no longer signed with the key.
  • Enter the Signing Domain. Use List DKIM Keys (All Domains) to find it.
  • Enter the DKIM Selector. Use List DKIM Keys (All Domains) or List Domain DKIM Keys to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Rotate DKIM Key

Rotates a domain's Automatic Sender Security DKIM key now.

  • Side effect: the old key is retired.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Update DKIM Key Rotation

Turns automatic DKIM key rotation on or off with each record (form fields): {"rotation_enabled", "rotation_interval"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update DKIM Authority

Changes a domain's DKIM authority with each record (form fields): {"self": true|false}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update DKIM Selector

Changes a domain's DKIM selector with each record (form fields): {"dkim_selector"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Suppressions​

Add Bounces

Adds addresses to a domain's bounce list. Each record (JSON) holds address, and optionally code and error.

  • Side effect: Mailgun stops sending to the added addresses.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Bounce

Removes one address from a domain's bounce list.

  • Side effect: Mailgun may send to the address again.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Email Address.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Clear Bounces

Deletes a domain's entire bounce list.

  • Side effect: Mailgun may send to those addresses again.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Add Unsubscribes

Adds addresses to a domain's unsubscribe list. Each record (JSON) holds address and optionally tags, such as ["*"] for all tags.

  • Side effect: Mailgun stops sending to the added addresses.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Unsubscribe

Removes one address from a domain's unsubscribe list.

  • Side effect: the address can get mail again.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Email Address.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Clear Unsubscribes

Deletes a domain's entire unsubscribe list.

  • Side effect: those addresses can get mail again.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Add Complaints

Adds addresses to a domain's complaint list. Each record (JSON) holds address.

  • Side effect: Mailgun stops sending to the added addresses.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Complaint

Removes one address from a domain's complaint list.

  • Side effect: the address can get mail again.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Email Address.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Clear Complaints

Deletes a domain's entire complaint list.

  • Side effect: those addresses can get mail again.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Add Allowlist Entry

Adds an address or domain to a domain's allowlist. Each record (form fields) holds address or domain.

  • Side effect: allowlisted addresses are never added to the bounce list.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Allowlist Entry

Removes an address or domain from a domain's allowlist.

  • Side effect: the address or domain can be added to the bounce list again.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Allowlist Value. Use List Allowlist to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Clear Allowlist

Deletes a domain's entire allowlist.

  • Side effect: removes every allowlist entry of the domain.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Webhooks​

Create Webhook

Creates an account-level webhook for each record. Each record holds the webhook url, the event_types to post, and an optional description.

  • Each record is sent as the JSON body of one request.
  • Mailgun documents this request as form data (multipart/form-data), not JSON, and may reject a JSON body. Test with a single record first.
  • See the Mailgun API reference for the request fields.

Update Account Webhook

Updates an account-level webhook with each record (form fields): {"url", "event_types", "description"}.

  • Enter the Webhook ID. Use List Webhooks to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Account Webhook

Deletes an account-level webhook.

  • Side effect: its URL gets no more events.
  • Enter the Webhook ID. Use List Webhooks to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Account Webhooks

Deletes several account-level webhooks by ID.

  • Side effect: their URLs get no more events.
  • Enter the Webhook IDs: a comma-separated list of webhook IDs from List Webhooks.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Domain Webhook

Creates a domain webhook from each record (form fields): {"id": "delivered", "url": "https://..."}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Domain Webhook

Replaces the URLs of one domain webhook event type with each record (form fields): {"url": "https://..."}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Webhook Event Type: an event type such as delivered, opened, clicked, or permanent_fail.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Domain Webhook

Deletes a domain webhook for one event type.

  • Side effect: that event type is no longer posted to its URLs.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Webhook Event Type: an event type such as delivered, opened, clicked, or permanent_fail.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Domain Webhooks (v4)

Adds a URL for several event types at once from each record (form fields): {"url", "event_types": "delivered,opened"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Domain Webhooks (v4)

Sets the event types a webhook URL gets from each record (form fields): {"url", "event_types": "delivered,opened"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Domain Webhooks (v4)

Removes a webhook URL from all event types of a domain.

  • Side effect: the URL gets no more events from the domain.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Webhook URL.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Routes and forwards​

Create Route

Creates an inbound route for each record. Each record holds the route priority, description, expression, and action.

  • Each record is sent as the JSON body of one request.
  • Mailgun documents this request as form data (application/x-www-form-urlencoded), not JSON, and may reject a JSON body. Test with a single record first.
  • See the Mailgun API reference for the request fields.

Update Route

Updates an inbound route with each record (form fields): {"priority", "description", "expression", "action"}.

  • Enter the Route ID. Use List Routes to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Route

Deletes an inbound route.

  • Side effect: matching mail is no longer forwarded or stored.
  • Enter the Route ID. Use List Routes to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Forward Rule

Creates an inbound forward rule from each record (form fields): {"match", "forward.url", "forward.recipient", "forward.store"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Forward Rule

Updates an inbound forward rule with each record (form fields): {"match", "forward.url", "forward.recipient", "forward.store"}.

  • Enter the Forward Rule ID. Use List Forward Rules to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Forward Rule

Deletes an inbound forward rule.

  • Side effect: matching mail is no longer forwarded.
  • Enter the Forward Rule ID. Use List Forward Rules to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Mailing lists​

Create Mailing List

Creates a mailing list from each record (form fields): {"address", "name", "description", "access_level", "reply_preference"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Mailing List

Updates a mailing list with each record (form fields): {"address", "name", "description", "access_level"}.

  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Mailing List

Deletes a mailing list and all its members.

  • Side effect: permanently deletes the list and its members.
  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Add Member to Mailing List

Adds one member to the mailing list for each record. Each record holds the member address, and optionally name, vars, subscribed, and upsert.

  • Enter the List Address. Use List Mailing Lists (Paged) to find it.
  • Each record is sent as the JSON body of one request.
  • Mailgun documents this request as form data (multipart/form-data), not JSON, and may reject a JSON body. Test with a single record first.
  • See the Mailgun API reference for the request fields.

Bulk Add Mailing List Members

Adds up to 1000 members per record (form fields): {"members": "<JSON array as text>", "upsert": "yes"}.

  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Mailing List Member

Updates a list member with each record (form fields): {"address", "name", "vars", "subscribed"}.

  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • Enter the Member Address. Use List Mailing List Members (Paged) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete Mailing List Member

Removes one member from a mailing list.

  • Side effect: the member no longer gets mail sent to the list.
  • Enter the Mailing List Address. Use List Mailing Lists (Paged) to find it.
  • Enter the Member Address. Use List Mailing List Members (Paged) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Templates​

Create Domain Template

Creates a domain template from each record (form fields): {"name", "description", "template", "tag", "engine"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Domain Template

Updates a domain template's description with each record (form fields): {"description"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Copy Domain Template

Copies a domain template to other domains from each record (JSON).

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Rename Domain Template

Renames a domain template to the new name in the URL.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Enter the New Template Name.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Domain Template

Deletes a domain template and all its versions.

  • Side effect: permanently deletes the template; sends that use it fail.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete All Domain Templates

Deletes every template of a domain.

  • Side effect: permanently deletes all of the domain's templates; sends that use them fail.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Domain Template Version

Adds a version to a domain template from each record (form fields): {"template", "tag", "active"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Domain Template Version

Updates a template version with each record (form fields): {"template", "comment", "active"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Enter the Version Tag. Use List Domain Template Versions to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Copy Domain Template Version

Copies a template version to a new version name (in the URL).

  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Enter the Version Tag. Use List Domain Template Versions to find it.
  • Enter the New Version Tag.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Domain Template Version

Deletes one version of a domain template.

  • Side effect: permanently deletes the version.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Template Name. Use List Domain Templates to find it.
  • Enter the Version Tag. Use List Domain Template Versions to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Account Template

Creates an account-level template from each record (form fields): {"name", "description", "template", "tag", "engine"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Account Template

Updates an account-level template's description with each record (form fields): {"description"}.

  • Enter the Template Name. Use List Account Templates to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Copy Account Template

Copies an account-level template from each record (JSON).

  • Enter the Template Name. Use List Account Templates to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Rename Account Template

Renames an account-level template to the new name in the URL.

  • Enter the Template Name. Use List Account Templates to find it.
  • Enter the New Template Name.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Account Template

Deletes an account-level template and all its versions.

  • Side effect: permanently deletes the template; sends that use it fail.
  • Enter the Template Name. Use List Account Templates to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete All Account Templates

Deletes every account-level template.

  • Side effect: permanently deletes all account-level templates; sends that use them fail.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Account Template Version

Adds a version to an account-level template from each record (form fields): {"template", "tag", "active"}.

  • Enter the Template Name. Use List Account Templates to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Account Template Version

Updates an account-level template version with each record (form fields): {"template", "comment", "active"}.

  • Enter the Template Name. Use List Account Templates to find it.
  • Enter the Version Tag. Use List Account Template Versions to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Copy Account Template Version

Copies an account-level template version to a new version name (in the URL).

  • Enter the Template Name. Use List Account Templates to find it.
  • Enter the Version Tag. Use List Account Template Versions to find it.
  • Enter the New Version Tag.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Account Template Version

Deletes one version of an account-level template.

  • Side effect: permanently deletes the version.
  • Enter the Template Name. Use List Account Templates to find it.
  • Enter the Version Tag. Use List Account Template Versions to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Tags​

Update Tag

Updates a tag's description with each record (JSON): {"tag", "description"}.

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Tag

Deletes a tag. Each record (JSON) holds tag.

  • Side effect: deletes the tag with its analytics.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

IPs and IP pools​

Request Dedicated IP

Adds a new dedicated IP to the account.

  • Side effect: the IP may be billed, depending on your plan.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Set IP Band

Places an account IP into a dedicated IP band with each record (form fields): {"ip_band"}.

  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Assign IP to All Domains

Assigns an IP to every domain of the account.

  • Side effect: every domain starts sending from the IP.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Remove IP from All Domains

Removes an IP from every domain of the account.

  • Side effect: the domains send from the alternative IP.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • Enter the Alternative IP.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Remove Domain IP

Removes an IP, or a linked IP pool, from a domain.

  • Side effect: the domain stops sending from it.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Remove Domain Pool IP

Removes an IP from a domain's pool, unlinks a dedicated IP pool, or removes the domain pool.

  • Side effect: the domain stops sending from the removed IPs.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create IP Pool

Creates a dedicated IP pool from each record (form fields): {"name", "description", "ips"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update IP Pool

Edits a dedicated IP pool with each record (form fields): {"name", "description", "add_ip", "remove_ip", "link_domain", "unlink_domain"}.

  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Add IP to IP Pool

Adds an IP to a dedicated IP pool (pool ID and IP in the URL).

  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Add IPs to IP Pool

Adds several IPs to a dedicated IP pool. Each record (JSON) holds ips, a list of IP addresses.

  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Remove IP from IP Pool

Removes an IP from a dedicated IP pool.

  • Side effect: the pool's domains stop sending from the IP.
  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete IP Pool

Deletes a dedicated IP pool.

  • Side effect: its domains move to the replacement IP or pool.
  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Enter the Replacement IP.
  • Enter the Replacement Pool ID. Use List IP Pools to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delegate IP Pool

Delegates a dedicated IP pool to a subaccount with each record (form fields): {"subaccount_id"}.

  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Revoke IP Pool Delegation

Revokes a dedicated IP pool's delegation to a subaccount. Each record (form fields) holds subaccount_id.

  • Side effect: the subaccount can no longer use the pool.
  • Enter the IP Pool ID. Use List IP Pools to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Set Account Spillover Pool

Sets the dedicated IP pool the account spills over to, from each record (JSON).

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Set Domain Spillover Pool

Sets the dedicated IP pool a domain spills over to, from each record (JSON).

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Create IP Warmup

Starts a warmup plan for an IP address (IP in the URL).

  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Cancel IP Warmup

Cancels an IP's warmup plan.

  • Side effect: the IP sends at full volume at once.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Dynamic IP pools​

Set Dynamic Pool IPs

Sets up or replaces the IPs of all dynamic IP pools from each record (form fields).

  • Side effect: replaces the IPs of every dynamic pool.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Add IP to Dynamic Pool

Adds an IP to a dynamic IP pool (pool name and IP in the URL).

  • Enter the Dynamic Pool Name. Use List Dynamic IP Pools to find it.
  • Enter the IP Address. Use List IPs or List IP Details to find it.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Update Dynamic Pool

Updates a dynamic pool's IPs with each record (form fields).

  • Enter the Dynamic Pool Name. Use List Dynamic IP Pools to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete All Dynamic Pools

Removes all of the account's dynamic IP pools.

  • Side effect: domains in dynamic pools lose their pool assignments.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Enroll All Domains in Dynamic Pools

Enrolls every domain of the account in dynamic IP pools.

  • Side effect: moves every domain's sending to dynamic IP pools.
  • Enter the Include Subaccounts: true or false.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Enroll Domain in Dynamic Pools

Enrolls a domain in dynamic IP pools.

  • Side effect: moves the domain's sending to dynamic IP pools.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Replacement IP.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Remove Domain from Dynamic Pools

Takes a domain out of dynamic IP pools.

  • Side effect: the domain sends from the replacement IP or pool.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the Replacement IP.
  • Enter the Replacement Pool ID. Use List IP Pools to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Override Dynamic Pool Assignment

Pins a domain to a dynamic IP pool with each record (form fields): {"pool"}.

  • Enter the Domain. Use List Domains (v4) to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Remove Dynamic Pool Override

Removes a domain's dynamic pool override.

  • Side effect: Mailgun reassigns the domain to a pool automatically.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Alerts and limits​

Create Alert

Creates an alert from each record (JSON): {"event_type", "channel": email|webhook|slack, "settings"}.

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Update Alert

Updates an alert (ID in the URL) with each record (JSON).

  • Enter the Alert ID.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Alert

Deletes an alert.

  • Side effect: the alert no longer notifies.
  • Enter the Alert ID.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Send Test Alert Email

Sends a test alert email. Each record (JSON) holds emails, the addresses to send it to.

  • Sends email: Mailgun sends a test alert email to the addresses in the record.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Send Test Alert to Slack

Posts a test alert to Slack channels. Each record (JSON) holds channel_ids.

  • Side effect: posts a message to the Slack channels.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Send Test Alert Webhook

Posts a test alert to a webhook URL. Each record (JSON) holds url.

  • Side effect: sends a request to the URL.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Update Slack Alert Settings

Updates the Slack alert settings with each record (JSON).

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Slack Alert Settings

Deletes the account's Slack alert settings.

  • Side effect: alerts are no longer posted to Slack.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Revoke Slack Access

Revokes Mailgun's access to Slack.

  • Side effect: Slack alerts stop.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Send Alert

Creates a send alert from each record (JSON): {"name", "metric", "comparator", "limit", "period", "filters"}.

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Update Send Alert

Updates a send alert (name in the URL) with each record (JSON).

  • Enter the Send Alert Name. Use List Send Alerts to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Send Alert

Deletes a send alert.

  • Side effect: the alert no longer notifies.
  • Enter the Send Alert Name. Use List Send Alerts to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Limit Threshold

Creates a limit threshold from each record (JSON).

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Update Limit Threshold

Updates a limit threshold (name in the URL) with each record (JSON).

  • Enter the Limit Threshold Name. Use List Limit Thresholds to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Limit Threshold

Deletes a limit threshold.

  • Side effect: the threshold no longer applies.
  • Enter the Limit Threshold Name. Use List Limit Thresholds to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Limit (v2)

Creates a sending limit from each record (JSON): {"metric", "limit"}.

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Update Limit (v2)

Updates the limit of one metric (in the URL) with each record (JSON): {"limit"}.

  • Enter the Metric. Use List Limits (v2) to find it.
  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Limit (v2)

Deletes the sending limit set for one metric.

  • Side effect: the limit no longer applies.
  • Enter the Metric. Use List Limits (v2) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Primary Limit Warning Settings

Creates the parent account's limit warning settings from each record (JSON).

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Update Primary Limit Warning Settings

Updates the parent account's limit warning settings with each record (JSON).

  • Each record is sent as the JSON body of one request.
  • See the Mailgun API reference for the request fields.

Delete Primary Limit Warning Settings

Deletes the parent account's limit warning settings.

  • Side effect: limit warnings stop.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Set Account Sending Limit

Sets the account's custom monthly sending limit (URL parameter).

  • Enter the Monthly Sending Limit: the number of messages; it has no default, so leaving it unset does not set a limit.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Account Sending Limit

Removes the account's custom monthly sending limit.

  • Side effect: the account no longer has a custom monthly limit.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Re-enable Account Sending

Re-enables an account disabled for hitting its custom sending limit.

  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Account, subaccounts, and keys​

Update Account Settings

Updates account settings with each record (form fields): {"name", "inactive_session_timeout", "absolute_session_timeout", "logout_redirect_url"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update Account Features

Turns account features on or off with each record (form fields), e.g. {"email_preview": "true"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Resend Activation Email

Resends the account activation email to the account owner.

  • Sends email: Mailgun sends the account activation email to the account owner again.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Create Subaccount

Creates a subaccount with the name in the URL parameter.

  • Enter the Subaccount Name.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Enable Subaccount

Re-enables a disabled subaccount.

  • Enter the Subaccount ID. Use List Subaccounts to find it.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Disable Subaccount

Disables a subaccount.

  • Side effect: the subaccount can no longer send.
  • Enter the Subaccount ID. Use List Subaccounts to find it.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Update Subaccount Features

Turns subaccount features on or off with each record (form fields).

  • Enter the Subaccount ID. Use List Subaccounts to find it.
  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Set Subaccount Sending Limit

Sets a subaccount's custom monthly sending limit (URL parameter).

  • Enter the Subaccount ID. Use List Subaccounts to find it.
  • Enter the Monthly Sending Limit: the number of messages; it has no default, so leaving it unset does not set a limit.
  • The record's content is not sent; each record repeats the same PUT request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Subaccount Sending Limit

Removes a subaccount's custom monthly sending limit.

  • Side effect: the subaccount no longer has a custom monthly limit.
  • Enter the Subaccount ID. Use List Subaccounts to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete API Key

Revokes one of the account's API keys.

  • Side effect: permanently revokes the key; every call that uses it fails.
  • Check the key ID before you activate this destination. Deleting the API key that this credential uses breaks every Mailgun source and destination that uses the credential.
  • Enter the API Key ID. Use List API Keys to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete SMTP Credential

Deletes one SMTP credential of a domain.

  • Side effect: SMTP logins with the credential fail.
  • Enter the Domain. Use List Domains (v4) to find it.
  • Enter the SMTP Login. Use List SMTP Credentials to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete All SMTP Credentials

Deletes every SMTP credential of a domain.

  • Side effect: SMTP logins with those credentials fail.
  • Enter the Domain. Use List Domains (v4) to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Add IP Allowlist Entry

Allows API calls from an IP or CIDR with each record (form fields): {"address", "description"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Update IP Allowlist Entry

Updates an allowlist entry's description with each record (form fields): {"address", "description"}.

  • Each record is sent as form fields. Send a field with several values as one comma-separated string.
  • See the Mailgun API reference for the request fields.

Delete IP Allowlist Entry

Removes an IP address from the account's API IP allowlist.

  • Side effect: API calls from that IP may be refused.
  • Enter the IP Address. Use List IP Allowlist to find it.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Add Sandbox Authorized Recipient

Adds an address to the sandbox domain's authorized recipients.

  • Sends email: Mailgun emails the address an invitation to receive mail from the sandbox domain.
  • Enter the Email Address.
  • The record's content is not sent; each record repeats the same POST request, so send a single record.
  • See the Mailgun API reference for the request fields.

Delete Sandbox Authorized Recipient

Removes an address from the sandbox domain's authorized recipients.

  • Side effect: the address can no longer get mail from the sandbox domain.
  • Enter the Email Address.
  • The record's content is not sent; each record repeats the same DELETE request, so send a single record.
  • See the Mailgun API reference for the request fields.

Manual configuration​

Mailgun destinations can also be manually configured to send data to any valid Mailgun API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Most Mailgun write endpoints expect form fields rather than JSON; send them URL-encoded. Nexla adds the Basic authentication header from the credential, so leave the Authorization header out of the request headers.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Mailgun endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Mailgun endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.