Connect AI agents to Mailgun

This tool takes no inputs.

This tool takes no inputs.

This tool takes no inputs.

This tool takes no inputs.

This tool takes no inputs.

include_metricsboolean

Whether to include usage metrics for each tag. Default false. When true, the maximum limit (in pagination) is 20.default false

include_subaccountsboolean

Whether to include tag data from all subaccounts under this account. Default false.default false

paginationobject

Pagination and sorting options for the tag list/search. Example: {"sort": "lastseen:desc", "limit": 10}.

tagstring

A tag name or tag prefix to filter/search for. Omit to list all tags.

template_namestringrequired

Account-level template name to fetch.

activestring

If set to 'yes', the active version of the template (including its content) is included in the response.

template_namestringrequired

Account-level template name the version belongs to.

version_namestringrequired

Tag of the version of the template to fetch.

limitinteger

Number of templates to retrieve. Default and max limit is 100.default 100

pstring

Pivot value used to retrieve the next/previous page of templates, taken from the 'paging' links of a prior response.

pagestring

Name of the page to retrieve relative to the pivot ('p'). Defaults to 'first'.one of firstlastnextprevious

template_namestringrequired

Account-level template name to fetch the versions for.

limitinteger

Number of versions to retrieve. Default and max limit is 100.default 100

pstring

Pivot value used to retrieve the next/previous page of versions, taken from the 'paging' links of a prior response.

pagestring

Name of the page to retrieve relative to the pivot ('p'). Defaults to 'first'.one of firstlastnextprevious

webhook_idstringrequired

The ID of the account-level webhook to retrieve.

webhook_idsstring

Comma-separated list of webhook IDs to filter results to. Omit to return all account-level webhooks.

idstringrequired

The Slack channel ID to look up, e.g. C012AB3CD. Use mailgun_alerts_list_slack_channels to find channel IDs.

This tool takes no inputs.

This tool takes no inputs.

limitinteger

Maximum number of Slack channels to return in this request.

pagestring

Encoded paging cursor, taken from the 'next' or 'first' link of a previous response. Omit to fetch the first page.

domain_namestringrequired

The sending domain to look up the allowlist entry from.

valuestringrequired

The address or domain value to search for in the allowlist, e.g. alice@example.com or example.com.

domain_namestringrequired

The sending domain to list allowlist entries for.

addressstring

Address serving as a pagination divider between pages. Optional in practice — omit it to fetch the first page of results.

limitinteger

Maximum number of records to return per page. Optional, default 100, max 1000.default 100

pagestring

Page direction relative to the address parameter. One of next, previous, or last. If empty, returns the first page.one of nextpreviouslast

termstring

Filter records to those whose address starts with the specified substring. Optional.

domain_namestring

Filter results to domain keys belonging to this domain.

kindstring

Filter results by key kind.one of domainuserweb

domainstringrequired

The sender domain name to list bounce classification event logs for.

entity_idstring

The entity ID (Email Service Entity or Spam Filter / Blocklist) to filter events by, e.g. gmail.

limitinteger

Limits the number of items returned in the response.

pagestring

Encoded paging information, provided via the 'next'/'previous' links of a prior response.

rule_idstring

The bounce classification rule ID to filter events by. Optional if the page cursor is passed (i.e. required to start the first query, optional for subsequent paged requests).

sortstring

Sort field and order. Default is '@timestamp:asc'.default @timestamp:asc

include_subaccountsboolean

Whether to include stats from subaccounts.default false

limitinteger

Limits the number of items returned in the response.

querystring

Query filter, e.g.: 'domain.name:example.com'.

skipinteger

Skips N items in the response, for pagination.

This tool takes no inputs.

domainstringrequired

The sender domain name to list per-entity bounce statistics for.

include_subaccountsboolean

Whether to include stats from subaccounts.default false

domainstringrequired

The sender domain name to list per-rule bounce statistics for.

entity_idstringrequired

The entity ID (Email Service Entity or Spam Filter / Blocklist), e.g. gmail.

include_subaccountsboolean

Whether to include stats from subaccounts.default false

This tool takes no inputs.

groupstring

Group response by fields: subaccount.id, domain.name, entity-id, or rule-id.one of subaccount.iddomain.nameentity-idrule-id

include_subaccountsboolean

Whether to include stats from subaccounts.default false

limitinteger

Limits the number of items returned in the response.

addressstringrequired

The email address to search for in the domain's bounce list.

domain_namestringrequired

The Mailgun sending domain to retrieve the bounce record from, e.g. mg.example.com.

domain_namestringrequired

The Mailgun sending domain to list bounces for, e.g. mg.example.com.

limitinteger

Maximum number of bounce records to return per page. Max 1000, default 100.default 100

pagestring

Page direction relative to the current cursor: next, previous, or last. Leave empty to return the first page.

termstring

Filter records to addresses that start with this substring.

addressstringrequired

The email address to search for in the domain's complaint list.

domain_namestringrequired

The Mailgun sending domain to retrieve the complaint record from, e.g. mg.example.com.

domain_namestringrequired

The Mailgun sending domain to list complaints for, e.g. mg.example.com.

addressstring

Address serving as a divider between pages, used together with the page parameter to move forward/backward through results.

limitinteger

Maximum number of complaint records to return per page. Max 1000, default 100.default 100

pagestring

Page direction relative to the address divider: next, previous, or last. Leave empty to return the first page.

termstring

Filter records to addresses that start with this substring.

limitinteger

Maximum number of domain keys to return per page. Default 10, max 100.default 10

pagestring

Encoded paging cursor copied from the 'next' or 'previous' link in a prior response's paging object. Omit on the first call to start from the first page.

selectorstring

Filter results to domain keys with this selector.

signing_domainstring

Filter results to domain keys belonging to this signing domain.

authority_namestringrequired

The domain authority name to list domain keys for. Must be a valid domain.

domain_namestringrequired

Domain name the template is stored under. Example: mg.example.com.

template_namestringrequired

Template name to fetch.

activestring

If set to 'yes', the active version of the template (including its content) is included in the response.

domain_namestringrequired

Domain name the template is stored under. Example: mg.example.com.

template_namestringrequired

Template name the version belongs to.

version_namestringrequired

Tag of the version of the template to fetch.

domain_namestringrequired

Domain name to fetch the templates for. Example: mg.example.com.

limitinteger

Number of templates to retrieve. Default and max limit is 100.default 100

pstring

Pivot value used to retrieve the next/previous page of templates, taken from the 'paging' links of a prior response.

pagestring

Name of the page to retrieve relative to the pivot ('p'). Defaults to 'first'.one of firstlastnextprevious

domain_namestringrequired

Domain name to fetch the template versions for. Example: mg.example.com.

template_namestringrequired

Template name to fetch the versions for.

limitinteger

Number of versions to retrieve. Default and max limit is 100.default 100

pstring

Pivot value used to retrieve the next/previous page of versions, taken from the 'paging' links of a prior response.

pagestring

Name of the page to retrieve relative to the pivot ('p'). Defaults to 'first'.one of firstlastnextprevious

domainstringrequired

The tracking domain of the TLS certificate, formatted as web_prefix.domain_name (web_prefix is configured in your domain's tracking settings).

namestringrequired

The name of the domain to fetch tracking settings for.

domain_namestringrequired

The sending domain the webhook is configured on.

webhook_namestringrequired

The webhook event type to look up.one of accepteddeliveredopenedclickedunsubscribedcomplainedtemporary_failpermanent_fail

domain_namestringrequired

The sending domain to list configured webhooks for.

namestringrequired

The name of the domain to fetch.

authoritystring

Filter domains by a specific authority (root domain that owns/manages the DNS). Ignored if state is also specified.

include_subaccountsboolean

Include domains belonging to any subaccounts under this account.default false

limitinteger

Maximum number of domains to return. Max 1000, default 100.default 100

searchstring

Search domains by partial or complete name. Does not support wildcards.

skipinteger

Number of domains to skip before starting to return results. Default 0.default 0

sortstring

Sort order. Valid values: name, name:asc, name:desc. If not specified, domains are returned in reverse creation date order.

statestring

Filter domains by state.one of activeunverifieddisabled

namestringrequired

The domain name to retrieve Dynamic IP Pool history for.

afterstring

Filter events emitted after a given timestamp. Format: 'Mon, 02 Jan 2006 15:04:05 MST'.

beforestring

Filter events emitted before a given timestamp. Format: 'Mon, 02 Jan 2006 15:04:05 MST'.

domainstring

Filter history events by domain name.

include_subaccountsboolean

If true, includes history events from all subaccounts in addition to the parent account.default false

limitinteger

Maximum number of history events to return (1-100).

moved_fromstring

Filter events by which Dynamic IP Pool a domain was moved from (e.g. dynamic_good, dynamic_poor).

moved_tostring

Filter events by which Dynamic IP Pool a domain was moved to (e.g. dynamic_good, dynamic_poor).

domainstring

Regex search term to filter assignable domains by name.

subaccount_idstring

If provided, lists assignable domains belonging to this subaccount instead of the parent account. Must be a valid account ID.

accountarray

Filter domains by account ID. Can be specified multiple times to filter by multiple accounts.

limitinteger

Maximum number of domains to return (1-100).

poolarray

Filter domains to specific Dynamic IP Pool(s). Can be specified multiple times.

sort_bystring

Field to sort domains by.one of bounce_ratecomplaint_ratenamedefault name

sort_orderstring

Sort direction for the sort_by field.one of ascendingdescendingdefault ascending

This tool takes no inputs.

namestringrequired

The domain name to preview a Dynamic IP Pool assignment for.

domain_namestringrequired

The sending domain to retrieve events for.

ascendingstring

Sort direction by time: 'yes' sorts ascending, 'no' sorts descending. Must be provided if 'end' is not specified. Live-confirmed: 'begin'/'end' must point the right direction for the chosen sort — for 'yes' (ascending), 'begin' must be the earlier timestamp and 'end' the later one; for 'no' (descending), it's the reverse ('begin' later, 'end' earlier). Mixing them up returns a clean 'Inconsistent range' error from Mailgun rather than silently sorting wrong.one of yesno

attachmentstring

Filter by the name of an attached file.

beginstring

Beginning of the search time range, in epoch seconds.

endstring

End of the search time range, in epoch seconds.

eventstring

Filter by event type (e.g. accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored, rejected).

fromstring

Filter by the email address in the message's From MIME header.

limitinteger

Number of entries to return per page. Maximum 300.

liststring

Filter by the mailing list email address the message was originally sent to.

message_idstring

Filter by the Mailgun message id returned by the Messages API.

recipientstring

Filter by the email address of a single recipient tracked by the event.

recipientsstring

For stored events, filter by any of the message's potential recipients.

severitystring

Filter failed events by severity: 'temporary' (Mailgun will retry delivery) or 'permanent' (Mailgun will not retry).one of temporarypermanent

sizestring

Filter by message size in bytes. Mostly intended for use with range filtering expressions.

subjectstring

Filter by the message's subject line.

tagsstring

Filter by user-defined tags applied to the message.

tostring

Filter by the email address in the message's To MIME header.

idstringrequired

The ID of the forward rule to retrieve.

domain_namestring

Scope the listing to forward rules defined on this domain only.

limitinteger

Maximum number of forward rules to return per page. Default 100.default 100

pagestring

Encoded paging cursor, taken from the 'next' or 'previous' links in a prior response. Omit to fetch the first page.

pool_idstringrequired

The ID of the dedicated IP pool (DIPP) to retrieve.

pool_idstringrequired

The ID of the dedicated IP pool (DIPP) to list linked domains for.

limitinteger

The maximum number of records to return, between 10 and 500. Defaults to 10.default 10

pagestring

Encoded page identifier retrieved from a previous call's paging.next or paging.first URL, used to continue pagination.

This tool takes no inputs.

addrstringrequired

The dedicated IP address to retrieve the warmup status for.

limitstring

The number of results to return per page. Defaults to 10 if not specified.default 10

pagestring

Encoded page identifier retrieved from a previous call's paging.next or paging.first URL. If omitted, the first page is returned.

ipstringrequired

The IP address to get details about.

This tool takes no inputs.

namestringrequired

The domain's INTERNAL ID (a Mongo ObjectID, e.g. 6a709fac9163aa838dac9844) — NOT the domain's DNS name. Live-confirmed: this endpoint rejects a DNS-style name with 'parsing domain id: the provided hex string is not a valid ObjectID'. Get the internal ID from mailgun_domains_get's or mailgun_domains_list's response (the 'id' field on the domain object).

This tool takes no inputs.

dedicatedboolean

If true, return only dedicated IPs. If omitted, both dedicated and shared IPs are returned.

enabledboolean

If true, return only enabled IPs. If omitted, both enabled and disabled IPs are returned.

domain_idstring

Filter IPs linked to a domain. Value can be a specific domain ID, 'any', or 'none'.

ipstring

Search for IPs containing this text (supports partial matching).

limitinteger

Maximum number of records to return. Minimum 10, maximum 100, default 10.default 10

pool_idstring

Filter IPs linked to a pool. Value can be a specific pool ID, 'any', or 'none'.

skipinteger

Number of records to skip before starting to return results. Default 0.default 0

sort_bystring

Name of the field to sort results by.

sort_orderstring

Sort results 'descending' or 'ascending'. Defaults to 'ascending'.one of ascendingdescendingdefault ascending

subaccount_idstring

Filter IPs linked to a subaccount. Value can be a specific subaccount ID, 'any', or 'none'.

ipstringrequired

The IP address to filter on. Must belong to the account.

limitinteger

The maximum number of domains to return. Default 100.default 100

searchstring

Search query that returned domain names must match (split into words, matched with logical OR). If omitted, no name filter is applied.

skipinteger

The number of matching domains to skip in the response. Default 0.default 0

namestringrequired

A user-friendly name that identifies this limit threshold. Used as the path identifier for get/update/delete operations.

This tool takes no inputs.

list_addressstringrequired

The address of the mailing list to retrieve, e.g. developers@mailgun.net.

list_addressstringrequired

The address of the mailing list the member belongs to, e.g. developers@mailgun.net.

member_addressstringrequired

The email address of the member to retrieve.

addressstring

Filter mailing lists matching a specific address.

limitinteger

Maximum number of mailing lists to return. Defaults to 100.default 100

skipinteger

Number of mailing lists to skip before starting to return results. Defaults to 0.default 0

limitinteger

Maximum number of mailing lists to return per page. Defaults to 100.default 100

list_addressstringrequired

The address of the mailing list whose members should be listed, e.g. developers@mailgun.net.

addressstring

Filter results to a member matching this valid email address.

limitinteger

Maximum number of records to return. Max is 100. Defaults to 100.default 100

skipinteger

Number of members to skip before starting to return results. Defaults to 0.default 0

subscribedboolean

Filter members by whether they are subscribed or not.

list_addressstringrequired

The address of the mailing list whose members should be paginated, e.g. developers@mailgun.net.

addressstring

Email address to use as the pivot point for pagination.

limitinteger

Set the maximum number of members to return per page. Defaults to 100.default 100

pagestring

Which page to fetch relative to the pivot address: first, last, next, or prev.one of firstlastnextprev

subscribedboolean

Filter members by whether they are subscribed or not.

domain_namestringrequired

The name of the domain to get sending queue status for, e.g. mg.example.com.

domain_namestringrequired

Domain name that was used to send the email, e.g. mg.example.com.

storage_keystringrequired

Storage key from the email's associated events (e.g. an Accepted or Delivered event's `storage.key` field). Only available for the duration of the domain's message retention policy.

idstringrequired

The unique identifier of the route to retrieve.

limitinteger

Maximum number of records to return. Defaults to 100; cannot be larger than 1000.default 100

skipinteger

Number of records to skip, for pagination. Defaults to 0.default 0

addressstringrequired

The email address to test against the account's configured routes.

namestringrequired

A user-friendly name that identifies this send alert. Used as the path identifier for get/update/delete operations.

This tool takes no inputs.

This tool takes no inputs.

domain_namestringrequired

The Mailgun sending domain to list SMTP credentials for.

limitinteger

Maximum number of credentials to return. Default 100.default 100

skipinteger

Number of results to skip, for pagination. Default 0.default 0

eventarrayrequired

Event type(s) to include. Multiple values are allowed and are sent as repeated 'event' query parameters. Supported values: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored.

durationstring

A duration expression (e.g. 7d, 1m) used to calculate 'start' from 'end'; when provided it overwrites the 'start' value.

endstring

End of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to the current time if omitted.

resolutionstring

Time resolution to bucket the stats by: hour, day, or month. Defaults to day.one of hourdaymonthdefault day

startstring

Start of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to 7 days before now if omitted.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

eventarrayrequired

Event type(s) to include. Multiple values are allowed and are sent as repeated 'event' query parameters. Supported values: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored.

durationstring

A duration expression (e.g. 7d, 1m) used to calculate 'start' from 'end'; when provided it overwrites the 'start' value.

endstring

End of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to the current time if omitted.

resolutionstring

Time resolution to bucket the stats by: hour, day, or month. Defaults to day.one of hourdaymonthdefault day

startstring

Start of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to 7 days before now if omitted.

eventarrayrequired

Event type(s) to include. Multiple values are allowed and are sent as repeated 'event' query parameters. Supported values: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored.

durationstring

A duration expression (e.g. 7d, 1m) used to calculate 'start' from 'end'; when provided it overwrites the 'start' value.

endstring

End of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to the current time if omitted.

filterstring

A filter expression for account-level metrics, e.g. 'domain:my.example.com'.

groupstring

The key to group metrics by. Must be one of: total, time, day, month, domain, ip, provider, tag, country.one of totaltimedaymonthdomainipprovidertagcountry

resolutionstring

Time resolution to bucket the stats by: hour, day, or month. Defaults to day.one of hourdaymonthdefault day

startstring

Start of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to 7 days before now if omitted.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

eventarrayrequired

Event type(s) to include. Multiple values are allowed and are sent as repeated 'event' query parameters. Supported values: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored.

timestampstringrequired

The date/time of the resolution period to retrieve totals for, in RFC 2822 format or Unix epoch seconds.

limitstring

Number of domains to skip; used to page through large numbers of domains.

resolutionstring

Time resolution to bucket the stats by: hour, day, or month. Defaults to day.one of hourdaymonthdefault day

subaccount_idstringrequired

The ID of the subaccount to fetch.

subaccount_idstringrequired

The ID of the subaccount whose custom monthly sending limit should be fetched.

closedboolean

Include closed subaccounts (true) or exclude closed subaccounts (false). Leave unset to allow either, depending on other parameters provided.

enabledboolean

Include enabled subaccounts (true) or disabled subaccounts (false). Leave unset to allow either, depending on other parameters provided.

filterstring

Name of the subaccount to filter by (partial or complete match).

limitinteger

Number of subaccounts to return. Between 1 and 1000, default 10.default 10

skipinteger

Number of subaccounts to skip for pagination. Default 0.default 0

sortstring

Sort order by name: 'asc' for ascending, 'desc' for descending.one of ascdesc

This tool takes no inputs.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

tagstringrequired

The name of the tag. Required to identify which tag to operate on.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

tagstringrequired

The name of the tag. Required to identify which tag to operate on.

typestringrequired

The type of aggregate breakdown to return for the tag: country, device, or provider.one of countrydeviceprovider

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

eventarrayrequired

Event type(s) to include. Multiple values are allowed and are sent as repeated 'event' query parameters. Supported values: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored.

tagstringrequired

The name of the tag. Required to identify which tag to operate on.

countrystring

Filter stats to this country value; see the List Supported Tag Countries tool for possible values.

devicestring

Filter stats to this device value; see the List Supported Tag Devices tool for possible values.

durationstring

A duration expression (e.g. 7d, 1m) used to calculate 'start' from 'end'; when provided it overwrites the 'start' value.

endstring

End of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to the current time if omitted.

providerstring

Filter stats to this ESP provider value; see the List Supported Tag Providers tool for possible values.

resolutionstring

Time resolution to bucket the stats by: hour, day, or month. Defaults to day.one of hourdaymonthdefault day

startstring

Start of the date range, in RFC 2822 format or Unix epoch seconds. Defaults to 7 days before now if omitted.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

limitinteger

Maximum number of tags to return in this request.

pagestring

The page direction to navigate, relative to the 'tag' cursor parameter. Valid values: first, last, next, prev.one of firstlastnextprev

prefixstring

Only list tags that begin with this prefix.

tagstring

The name of the tag, used to identify which tag to operate on. Used as the pagination cursor marking the end of the current page.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

domain_namestringrequired

The Mailgun sending domain to scope this request to (e.g. mg.example.com). This is the email-sending domain, not the account's API region domain configured on the connection.

addressstringrequired

The email address to search for, e.g. alice@example.com.

domain_namestringrequired

The Mailgun domain to retrieve the unsubscribe record from, e.g. mg.example.com.

domain_namestringrequired

The Mailgun domain to retrieve unsubscribes from, e.g. mg.example.com.

addressstring

The address that serves as a 'divider' (cursor) between pages, used together with Page Direction. Leave blank to start from the first page. Note: Mailgun's spec marks this as required, but it is only needed for paging past the first page in practice.

limitinteger

Maximum number of unsubscribe records to return per page. Optional, default 100, max 1000.default 100

pagestring

Page direction relative to the 'address' cursor: 'next', 'previous', or 'last'. If omitted, the first page is returned.one of nextpreviouslast

termstring

Filter records to addresses that start with this substring. Leave blank to return all unsubscribes. Note: Mailgun's spec marks this as required, but it is optional in practice.

user_idstringrequired

The ID of the user on the account to retrieve, e.g. '123'.

This tool takes no inputs.

limitinteger

The maximum number of users to return. Leave blank to use Mailgun's default page size.

rolestring

Filter users by role. Valid values: basic (== analyst), billing, support, developer, admin. Leave blank to return users of all roles.one of basicbillingsupportdeveloperadmin

skipinteger

The number of users to skip before returning results, for pagination. Leave blank to start from the beginning.

addressstringrequired

The email address to validate.

provider_lookupboolean

Whether to perform a mailbox provider lookup as part of validation. Defaults to true on Mailgun's side if omitted.

list_idstringrequired

The ID of the bulk validation job to look up.

limitinteger

Maximum number of jobs to return per page.

skipinteger

Number of jobs to skip before starting to return results, for pagination.

emailstringrequired

The email address of the new authorized sandbox recipient, e.g. alice@example.com.

addressstringrequired

The IP address to allowlist for account/API/SMTP access.

descriptionstring

An optional human-readable description for this allowlist entry. Defaults to an empty string if omitted.

addressstringrequired

The already-allowlisted IP address whose description should be updated.

descriptionstring

The new description for this entry. Defaults to an empty string if omitted.

This tool takes no inputs.

limitnumberrequired

The custom monthly sending limit to set for the account. Must be at least 1000 (Mailgun rejects lower values with a 400).

This tool takes no inputs.

This tool takes no inputs.

descriptionstringrequired

The new description to set for this tag.

tagstringrequired

The name of the tag to update.

requestsarrayrequired

List of copy requests. Each item must include account_id and name, and may include an optional domain to copy into a different target domain. Example: [{"account_id":"account-id-1","name":"new-template-name-1"},{"account_id":"account-id-2","name":"new-template-name-2","domain":"target-domain"}]

template_namestringrequired

The name of the source account-level template to copy.

source_versionsarray

Specific version tags to copy from the source template. If omitted or empty, all versions are copied.

new_version_namestringrequired

The name for the new (copied) version. If a version with this name already exists, the copy fails.

template_namestringrequired

Account-level template name the version is stored under.

version_namestringrequired

Tag of the source version to copy.

commentstring

Comment to be used for the new version.

namestringrequired

Name of the account-level template being stored. Supports UTF-8 characters; the name is stored down-cased.

commentstring

Version comment. Only valid if a new version is being created (i.e. 'template' is provided).

descriptionstring

Description of the template being stored.

headersstring

JSON-encoded object of MIME headers to store with the template. Only the keys From, Subject, and Reply-To are currently supported; they are inserted into the MIME at delivery time and message-level headers override template-level ones.

tagstring

Initial tag of the created version. If 'template' is provided and tag is omitted, the default value 'initial' is used.

templatestring

Content of the template (HTML/text/handlebars). If provided, an initial version is automatically created and becomes active. Binary attachments and inline file content are not supported; use inline text/HTML only.

tagstringrequired

Tag of the version being created. Must be unique within the template.

templatestringrequired

Content of the new template version (HTML/text/handlebars). Binary attachments and inline file content are not supported; use inline text/HTML only.

template_namestringrequired

Name of the existing account-level template to create the new version for.

activestring

If set to 'yes', this version becomes the active version immediately.

commentstring

Comment related to the version that is being created.

headersstring

JSON-encoded object of MIME headers to store with this version. Only the keys From, Subject, and Reply-To are currently supported.

new_template_namestringrequired

The name for the new (renamed) template. Fails if this name is already in use.

template_namestringrequired

The current name of the account-level template.

descriptionstringrequired

Updated description of the template.

template_namestringrequired

The name of the account-level template to update.

template_namestringrequired

Account-level template name the version is stored under.

version_namestringrequired

Tag of the version of the template to be updated.

activestring

If set to 'yes', this version becomes the active version.

commentstring

Updated comment related to the version.

headersstring

JSON-encoded object of MIME headers to store with this version. Only the keys From, Subject, and Reply-To are currently supported.

templatestring

New content of the template version (HTML/text/handlebars). Binary attachments and inline file content are not supported; use inline text/HTML only. Leave blank to keep the existing content.

ai_insightsstring

JSON object (encoded as a string) configuring the AI Insights feature, e.g. '{"enabled": false}'. Only required if this is the feature you're updating; leave blank otherwise.

webhooks_redact_piistring

JSON object (encoded as a string) configuring PII redaction in webhook payloads, e.g. '{"enabled": false}'. Only required if this is the feature you're updating; leave blank otherwise.

absolute_session_timeoutinteger

The absolute login session timeout period limit (in seconds), regardless of activity. Leave blank if not updating this setting.

inactive_session_timeoutinteger

The login session timeout period (in seconds) for inactivity. Leave blank if not updating this setting.

logout_redirect_urlstring

The URL to redirect users to upon logout. Leave blank if not updating this setting.

namestring

The new account organization name. Leave blank if not updating this setting.

event_typesarrayrequired

One or more event types this webhook should fire for. Provide each as a separate array element; Mailgun's API accepts this parameter repeated (event_types=opened&event_types=clicked), not as a single comma-joined value.

urlstringrequired

The destination URL that will receive Mailgun's POST callback.

descriptionstring

A human-readable description of what this webhook is for.

event_typesarrayrequired

The new set of event types this webhook should fire for, replacing the previous set. Provide each as a separate array element; Mailgun's API accepts this parameter repeated (event_types=opened&event_types=clicked), not as a single comma-joined value.

urlstringrequired

The new destination URL that will receive Mailgun's POST callback.

webhook_idstringrequired

The ID of the account-level webhook to update.

descriptionstring

A human-readable description of what this webhook is for. Omit to clear it.

channelstringrequired

The delivery method for the alert: email, webhook, or slack.one of emailwebhookslack

event_typestringrequired

The type of event to alert on, e.g. ip_listed or ip_delisted. Use mailgun_alerts_list_events to fetch the current valid set of event types for your account.

settingsobjectrequired

Channel-specific settings object; its shape depends on the channel value. For channel=webhook use {"url": "https://yourwebhookurl.com"}. For channel=email use {"emails": ["recipient@example.com"]}. For channel=slack use {"channel_ids": ["C0123"]}.

This tool takes no inputs.

emailsarrayrequired

List of email addresses to send the test alert to.

event_typestringrequired

The event type to simulate in the test alert message (e.g. ip_listed). Any valid event type can be used, it does not need an actual configured alert.

event_typestringrequired

The event type to simulate in the test alert message (e.g. ip_listed). Any valid event type can be used, it does not need an actual configured alert.

channel_idsarray

Slack channel IDs to send the test message to. If omitted, the channel IDs already configured on this event's alert settings are used instead.

event_typestringrequired

The event type to simulate in the test alert message (e.g. ip_listed). Any valid event type can be used, it does not need an actual configured alert.

urlstringrequired

The webhook URL to send the test POST request to.

channelstringrequired

The delivery method for the alert: email, webhook, or slack.one of emailwebhookslack

event_typestringrequired

The type of event to alert on, e.g. ip_listed or ip_delisted. Use mailgun_alerts_list_events to fetch the current valid set of event types for your account.

idstringrequired

The ID of the alert settings record to update. Obtain this from mailgun_alerts_list_alerts.

settingsobjectrequired

Channel-specific settings object; its shape depends on the channel value. For channel=webhook use {"url": "https://yourwebhookurl.com"}. For channel=email use {"emails": ["recipient@example.com"]}. For channel=slack use {"channel_ids": ["C0123"]}.

tokenstringrequired

The Slack bot OAuth token (begins with xoxb-) used to authenticate Mailgun's calls to the Slack API.

scopestring

Comma-separated list of OAuth scopes granted to this Slack token.

team_idstring

The Slack workspace (team) ID this token belongs to.

team_namestring

The Slack workspace (team) display name this token belongs to.

domain_namestringrequired

The Mailgun domain to add the allowlist entry to, e.g. example.com.

addressstring

Valid email address to add to the allowlist. Either address or domain must be supplied; if both are provided, address takes priority over domain (per Mailgun's API).

domainstring

Valid domain name to allowlist in its entirety. Either address or domain must be supplied; ignored if address is also given.

rolestringrequired

Key role, which determines the permissions granted to the key. 'admin' grants full account access, 'basic' grants analyst-level (read-mostly) access, 'sending' grants domain-scoped sending access (use only with kind='domain'), and 'developer' grants developer-level access.one of adminbasicsendingdeveloper

descriptionstring

Free-text description of the key's purpose.

domain_namestring

Web domain to associate with the key. Required in practice when kind is 'domain'.

emailstring

API key user's email address. Should be provided for all keys of kind 'web'.

expirationinteger

Key lifetime in seconds. Must be greater than 0 if set. If omitted, the key does not expire (unless kind is 'web', which has a maximum 1-day validity regardless).

kindstring

Type of API key to create. Defaults to 'user' if not provided. 'web' keys are not subject to IP allowlisting and have a maximum validity of 1 day.one of domainuserweb

user_idstring

API key user's string user ID. Should be provided for all keys of kind 'web'.

user_namestring

API key user's display name.

This tool takes no inputs.

dimensionsarray

Dimensions to group/break down the returned metrics by. Valid values: entity-name, domain.name, envelope.sending-ip, account.name, envelope.i-ip-pool-name, tags, tag, recipient-domain, group-id, criticality, severity, category, timestamp. Mailgun enforces an undocumented (not in the OpenAPI spec) maximum of 4 dimensions per request, rejecting 5+ with 'too many dimensions' regardless of which ones are chosen.

durationstring

A duration in the format '48h', '60m', or '30s'. If provided, it is calculated from the end date and overwrites the start date.

endstring

An end timestamp in RFC 2822 format (e.g. 'Mon, 02 Jan 2006 22:04:05 UTC'). Defaults to the current time if omitted.

filterobject

Advanced filter expression narrowing results. Shape: {"AND": [{"attribute": <dimension or field name>, "comparator": "=", "values": [{"value": "..."}]}]}. Example: {"AND": [{"attribute": "domain.name", "comparator": "=", "values": [{"value": "example.com"}]}]}.

include_subaccountsboolean

Include stats from all subaccounts. Omitted from the request entirely if not set.

metricsarray

Metrics to return. Known values include: critical_bounce_count, non_critical_bounce_count, critical_delay_count, non_critical_delay_count, delivered_smtp_count, classified_failures_count, critical_bounce_rate, non_critical_bounce_rate, critical_delay_rate, non_critical_delay_rate.

pagination_limitinteger

The maximum number of items returned in the response. Maximum 50, default 10.

pagination_skipinteger

The number of items to skip over when satisfying the request. Set to zero for the first page, then increment by the limit for subsequent calls.

pagination_sortstring

Colon-separated value indicating the column name and sort direction for pagination, e.g. 'entity-name:asc'.

resolutionstring

Resolution of the metrics: 'day' or 'hour'.one of dayhour

startstring

A start timestamp in RFC 2822 format (e.g. 'Sun, 01 Jan 2006 22:04:05 UTC'). Defaults to 7 days before the current time if omitted.

bouncesarrayrequired

Array of bounce records to add (max 1000 per call). Each item requires an address; code (SMTP error code, e.g. "550"), error (SMTP error message), and createdat (RFC2822 timestamp) are optional and default on Mailgun's side when omitted. Example: [{"address": "alice@example.com", "code": "550", "error": "Bounced", "createdat": "Thu, 11 Dec 2025 01:49:40 UTC"}]

domain_namestringrequired

The Mailgun sending domain to add the bounce records to, e.g. mg.example.com.

complaintsarrayrequired

Array of complaint records to add (max 1000 per call). Each item requires an address; createdat (RFC2822 timestamp) is optional and defaults to the current time on Mailgun's side when omitted. Example: [{"address": "alice@example.com", "createdat": "Thu, 11 Dec 2025 01:49:40 UTC"}]

domain_namestringrequired

The Mailgun sending domain to add the complaint records to, e.g. mg.example.com.

domain_namestringrequired

The domain name whose DKIM key should be rotated. Must be a domain already added to your Mailgun account, in the 'enabled' state.

domain_namestringrequired

The domain name whose DKIM rotation policy should be updated.

rotation_enabledbooleanrequired

If true, enables DKIM auto-rotation for the domain. If false, disables it.

rotation_intervalstring

The interval at which to rotate keys, e.g. '5d' for five days. Minimum allowed interval is 5 days. Only allowed when rotation_enabled is true.

authority_namestringrequired

The domain authority name to activate the key for. Must be a valid domain.

selectorstringrequired

The DKIM selector of the key to activate. Must be a valid dot atom.

selectorstringrequired

Selector to identify the new domain key. Must be unique per domain.

signing_domainstringrequired

Signing domain to associate the new domain key with.

bitsinteger

Key size in bits for a newly generated key. Valid values: 1024 or 2048. Ignored when importing via 'pem'.one of 10242048

pemstring

Existing RSA private key to import, as PEM text (PKCS #1, ASN.1 DER format). Note: only pasted PEM text is supported here, not a binary file upload.

authority_namestringrequired

The domain authority name to deactivate the key for. Must be a valid domain.

selectorstringrequired

The DKIM selector of the key to deactivate. Must be a valid dot atom.

namestringrequired

The domain name to update the DKIM authority for.

selfboolean

If true, the domain becomes the DKIM authority for itself. If false, the domain uses the same DKIM authority as the root domain registered on the same Mailgun account.

namestringrequired

The domain name to update the DKIM selector for.

dkim_selectorstring

New DKIM selector for the domain. Must be unique among the domain's key selectors. If omitted, no change is made.

domain_namestringrequired

Domain name the source template is associated with. Example: mg.example.com.

requestsarrayrequired

List of copy requests. Each item must include account_id and name, and may include an optional domain to copy into a different target domain. Example: [{"account_id":"account-id-1","name":"new-template-name-1"},{"account_id":"account-id-2","name":"new-template-name-2","domain":"target-domain"}]

template_namestringrequired

The name of the source template to copy.

source_versionsarray

Specific version tags to copy from the source template. If omitted or empty, all versions are copied.

domain_namestringrequired

Domain name the template is associated with. Example: mg.example.com.

new_version_namestringrequired

The name for the new (copied) version. If a version with this name already exists, the copy fails.

template_namestringrequired

Template name the version is stored under.

version_namestringrequired

Tag of the source version to copy.

commentstring

Comment to be used for the new version.

domain_namestringrequired

Domain name the template will be created under. Example: mg.example.com.

namestringrequired

Name of the template being stored. Supports UTF-8 characters; the name is stored down-cased.

commentstring

Version comment. Only valid if a new version is being created (i.e. 'template' is provided).

descriptionstring

Description of the template being stored.

headersstring

JSON-encoded object of MIME headers to store with the template. Only the keys From, Subject, and Reply-To are currently supported; they are inserted into the MIME at delivery time and message-level headers override template-level ones.

tagstring

Initial tag of the created version. If 'template' is provided and tag is omitted, the default value 'initial' is used.

templatestring

Content of the template (HTML/text/handlebars). If provided, an initial version is automatically created and becomes active. Binary attachments and inline file content are not supported; use inline text/HTML only.

domain_namestringrequired

Domain name the template is associated with. Example: mg.example.com.

tagstringrequired

Tag of the version being created. Must be unique within the template.

templatestringrequired

Content of the new template version (HTML/text/handlebars). Binary attachments and inline file content are not supported; use inline text/HTML only.

template_namestringrequired

Name of the existing template to create the new version for.

activestring

If set to 'yes', this version becomes the active version immediately.

commentstring

Comment related to the version that is being created.

headersstring

JSON-encoded object of MIME headers to store with this version. Only the keys From, Subject, and Reply-To are currently supported.

domain_namestringrequired

Domain name the template is associated with. Example: mg.example.com.

new_template_namestringrequired

The name for the new (renamed) template. Fails if this name is already in use.

template_namestringrequired

The current name of the template.

descriptionstringrequired

Updated description of the template.

domain_namestringrequired

Domain name the template is associated with. Example: mg.example.com.

template_namestringrequired

The name of the template to update.

domain_namestringrequired

Domain name the template is associated with. Example: mg.example.com.

template_namestringrequired

Template name the version is stored under.

version_namestringrequired

Tag of the version of the template to be updated.

activestring

If set to 'yes', this version becomes the active version.

commentstring

Updated comment related to the version.

headersstring

JSON-encoded object of MIME headers to store with this version. Only the keys From, Subject, and Reply-To are currently supported.

templatestring

New content of the template version (HTML/text/handlebars). Binary attachments and inline file content are not supported; use inline text/HTML only. Leave blank to keep the existing content.

domainstringrequired

The tracking domain to generate a TLS certificate for, formatted as web_prefix.domain_name (web_prefix is configured in your domain's settings).

domainstringrequired

The tracking domain whose expired TLS certificate should be regenerated, formatted as web_prefix.domain_name (web_prefix is configured in your domain's settings).

namestringrequired

The name of the domain to update click tracking for.

activestring

Click tracking state: 'htmlonly' (track clicks in HTML body only), 'true' (track in HTML and plain text), or 'false' (disabled). Omit to make no change.one of htmlonlytruefalse

namestringrequired

The name of the domain to update open tracking for.

activeboolean

Set true or false to toggle open tracking's active status. Omit to make no change.

place_at_the_topboolean

If true, the open-tracking pixel is placed at the top of the HTML body when inserted into the email MIME. Omit to keep the current setting.

namestringrequired

The name of the domain to update unsubscribe tracking for.

activeboolean

Toggle the active status of unsubscribe tracking on the domain. Omit to make no change.

html_footerstring

HTML footer containing the unsubscribe link, inserted into the HTML part of outgoing email MIME. Use %unsubscribe_url% as the link placeholder.

text_footerstring

Plain-text footer containing the unsubscribe link, inserted into the plain-text part of outgoing email MIME. Use %unsubscribe_url% as the link placeholder.

domain_namestringrequired

The sending domain to create the webhook on.

urlsarrayrequired

One or more URLs to receive the POST callback for this event type (max 3). Provide each URL as a separate array element; Mailgun's API accepts this parameter repeated (url=https://a&url=https://b), not as a single comma-joined value.

webhook_namestringrequired

The event type this webhook fires for.one of accepteddeliveredopenedclickedunsubscribedcomplainedtemporary_failpermanent_fail

domain_namestringrequired

The sending domain the webhook is configured on.

urlsarrayrequired

The new set of URLs for this event type (max 3), replacing whatever was previously configured. Provide each URL as a separate array element; Mailgun's API accepts this parameter repeated (url=https://a&url=https://b), not as a single comma-joined value.

webhook_namestringrequired

The event type whose webhook URL(s) to replace.one of accepteddeliveredopenedclickedunsubscribedcomplainedtemporary_failpermanent_fail

namestringrequired

The name of the new domain to create.

archive_tostring

If set to a URL, each successfully delivered message is also submitted as an HTTP POST (Content-Type application/mime) to this URL, with the body being exactly what the recipient SMTP server received.

dkim_host_namestring

Set the DKIM host name for the domain being created. Must be a valid domain name (the domain being created or its root domain). Cannot be used together with force_dkim_authority or force_root_dkim_host.

dkim_key_sizestring

The size of the new domain's DKIM key. Must be either 1024 or 2048.one of 10242048

dkim_selectorstring

Explicitly set the DKIM selector for the domain being created. If the domain key does not already exist, one will be created. Must be a valid RFC 2822 atom (no dots), e.g. 'foobar' is valid but 'foo.bar' is not.

encrypt_incoming_messageboolean

Enable encrypting incoming messages for this domain. Cannot be altered via API after being set, for security purposes; contact Mailgun Support to disable. Defaults to false.default false

force_dkim_authorityboolean

If true, the domain is its own DKIM authority even if its root domain is registered on the same Mailgun account. If false, the domain shares the root domain's DKIM authority. Defaults to false.default false

force_root_dkim_hostboolean

If true, the root domain becomes the DKIM host for the domain being created even if the root domain itself is not registered with Mailgun. Verification still requires valid SPF for this domain and a valid DKIM record for the root domain; the SMTP mail-from host stays the domain being created.

ipsstring

An optional comma-separated list of IP addresses to assign to this domain. If not specified, all dedicated IP addresses on the account are assigned. Returns a 400 if a requested IP isn't assigned to the account.

message_ttlinteger

Time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. The maximum allowed TTL depends on your Mailgun subscription plan.

pool_idstring

Requested IP pool to be assigned to the domain at creation time.

require_tlsboolean

If true, messages for this domain may only be sent over a TLS connection; if a TLS connection can't be established, Mailgun will not deliver the message. If false, Mailgun still tries to upgrade the connection but falls back to plaintext SMTP. Defaults to false.default false

skip_verificationboolean

If true, the certificate and hostname are not verified when establishing a TLS connection, and Mailgun accepts any certificate during delivery. If false, Mailgun verifies the certificate and hostname and will not establish a TLS connection if either fails. Defaults to false.default false

smtp_passwordstring

Password to use for SMTP authentication on this domain. If not provided, Mailgun generates one.

spam_actionstring

How to handle inbound spam: 'disabled' (no spam filtering), 'block' (spam messages aren't delivered), or 'tag' (messages are tagged with a spam header). Defaults to disabled.one of disabledblocktagdefault disabled

use_automatic_sender_securityboolean

Enable Automatic Sender Security. Requires setting DNS CNAME entries for DKIM keys instead of a TXT record. Defaults to false.default false

web_prefixstring

Sets the subdomain prefix used for open/click/unsubscribe tracking URLs, e.g. <web_scheme>://<web_prefix>.<domain_name>/... Defaults to 'email'.default email

web_schemestring

Sets the scheme (http or https) used for open/click/unsubscribe tracking URLs. https requires a valid TLS certificate for the domain's tracking host. Defaults to http.one of httphttpsdefault http

webhooks_redact_piiboolean

If true, Personally Identifiable Information (PII) is redacted from the payload of any webhook posted for this domain.

wildcardboolean

Allows the domain to accept inbound messages received on subdomains that have MX records pointed to Mailgun. Defaults to false.default false

namestringrequired

The name of the domain to update.

archive_tostring

If set to a URL, each successfully delivered message is also submitted as an HTTP POST (Content-Type application/mime) to this URL, with the body being exactly what the recipient SMTP server received. Leave unset to keep the current value.

mailfrom_hoststring

The mail-from hostname to update to. Must be lower case. Leave unset to keep the current value.

message_ttlinteger

Time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. Maximum allowed value depends on your subscription plan. Leave unset to keep the current value.

require_tlsboolean

If true, messages for this domain may only be sent over a TLS connection; if a TLS connection can't be established, Mailgun will not deliver the message. If false, Mailgun still tries to upgrade the connection but falls back to plaintext SMTP. Leave unset to keep the current value.

skip_verificationboolean

If true, certificate and hostname are not verified when establishing a TLS connection and Mailgun accepts any certificate during delivery. If false, Mailgun verifies the certificate and hostname and won't establish a TLS connection if either fails. Leave unset to keep the current value.

smtp_passwordstring

Updates the domain's SMTP credentials to this password. Leave unset to keep the current value.

spam_actionstring

Updates the domain's spam action. Valid values are 'disabled', 'tag', and 'block'. Leave unset to keep the current value.one of disabledtagblock

use_automatic_sender_securityboolean

Enable or disable Automatic Sender Security. If enabled, requires setting DNS CNAME entries for DKIM keys instead of a TXT record. The domain must be re-verified after changing this field. Leave unset to keep the current value.

web_prefixstring

Updates the subdomain prefix used for the domain's open/click/unsubscribe tracking features. Must be a valid atom. Updating this also requires creating a matching CNAME record in the domain's DNS zone (e.g. prefix 'zed' on my-domain.com needs a CNAME for zed.my-domain.com). Leave unset to keep the current value.

web_schemestring

Updates the scheme (http or https) used for open/click/unsubscribe tracking URLs. https requires a valid TLS certificate for the domain's tracking host. Leave unset to keep the current value.one of httphttps

webhooks_redact_piiboolean

If true, Personally Identifiable Information (PII) is redacted from the payload of any webhook posted for this domain. Leave unset to keep the current value.

wildcardboolean

Updates the domain's wildcard status, i.e. whether it accepts inbound messages received on subdomains that have MX records pointed to Mailgun. Leave unset to keep the current value.

namestringrequired

The name of the domain to verify.

ipstringrequired

The dedicated IP address to add to the given Dynamic IP Pool. Must already belong to the account.

pool_namestringrequired

Name of the Dynamic IP Pool to add the IP to.

include_subaccountsbooleanrequired

If true, domains belonging to subaccounts will also be enrolled in Dynamic IP Pools.

namestringrequired

The domain name to enroll in Dynamic IP Pools.

replacement_ipstringrequired

A valid dedicated IP address or the string 'shared' to assign to the domain while it is being enrolled.

good_reputationstringrequired

Comma-separated list of dedicated IP(s) to place in the good_reputation (dynamic_good) pool.

new_sendersstringrequired

Comma-separated list of dedicated IP(s) to place in the new_senders (dynamic_new) pool.

poor_reputationstringrequired

Comma-separated list of dedicated IP(s) to place in the poor_reputation (dynamic_poor) pool.

namestringrequired

The domain name whose Dynamic IP Pool assignment should be overridden.

poolstringrequired

Name of the Dynamic IP Pool to assign to the domain (e.g. dynamic_good, dynamic_new).

pool_namestringrequired

Name of the Dynamic IP Pool to update.

add_ipstring

Comma-separated dedicated IP(s) to add to the pool. Provide this and/or remove_ip.

remove_ipstring

Comma-separated dedicated IP(s) to remove from the pool. Provide this and/or add_ip.

matchstringrequired

A wildcard expression matching the recipient address to forward. Case-insensitive. Only '*' (matches any sequence of characters) or literal characters are supported — not a full regex. Example: 'a.*@example.com' matches addresses starting with 'a.', not addresses starting with 'a'.

forward_recipientarray

One or more email addresses to forward matching mail to (up to 5). At least one of forward_recipient, forward_url, or forward_store must be provided.

forward_storestring

A URL which will be notified when a matching email arrives, along with a URL you can use to retrieve the stored message. Must be a valid URL that resolves. At least one of forward_recipient, forward_url, or forward_store must be provided.

forward_urlarray

One or more URLs to forward matching mail to via HTTP POST (up to 3). Each must be a valid URL that resolves. At least one of forward_recipient, forward_url, or forward_store must be provided.

idstringrequired

The ID of the forward rule to update.

forward_recipientarray

New set of email addresses to forward matching mail to (up to 5), replacing any existing recipients. Leave unset to keep the current recipients.

forward_storestring

New URL to notify (with a retrieval link) when matching mail arrives and is stored. Leave unset to keep the current value.

forward_urlarray

New set of URLs to forward matching mail to via HTTP POST (up to 3), replacing any existing URLs. Leave unset to keep the current URLs.

matchstring

New wildcard expression matching the recipient address to forward. Case-insensitive; only '*' or literal characters are supported (not a full regex). Leave unset to keep the current match expression.

ipstringrequired

The dedicated IP address to add to the pool. Must be a dedicated IP already owned by the account and not currently assigned to a different pool.

pool_idstringrequired

The ID of the dedicated IP pool (DIPP) to add the IP to.

ipsarrayrequired

List of dedicated IP addresses to add to the pool. Each must already be a dedicated IP owned by the account and not currently assigned to a different pool. Example: ["1.2.3.4", "5.6.7.8"].

pool_idstringrequired

The ID of the dedicated IP pool (DIPP) to add the IPs to.

descriptionstringrequired

Longer, human-readable description of the new DIPP.

namestringrequired

Short name of the new DIPP.

iparray

One or more dedicated IP addresses to add to the pool at creation time. Each must already be a dedicated IP owned by the account and not currently assigned to a different pool. Provide each IP as a separate array element — Mailgun's API accepts this parameter repeated (ip=1.2.3.4&ip=5.6.7.8), not as a single comma-joined value.

pool_idstringrequired

The ID of the dedicated IP pool (DIPP) to delegate.

subaccount_idstringrequired

The ID of the subaccount to delegate the pool to.

pool_idstringrequired

The ID of the dedicated IP pool (DIPP) to edit.

add_iparray

One or more dedicated IP addresses to add to the pool. Each must already be a dedicated IP owned by the account and not currently assigned to a different pool. Provide each IP as a separate array element — Mailgun's API accepts this parameter repeated (add_ip=1.2.3.4&add_ip=5.6.7.8), not as a single comma-joined value.

descriptionstring

New longer description for the DIPP.

link_domainarray

One or more domain IDs to link to this DIPP. Provide each domain ID as a separate array element — Mailgun's API accepts this parameter repeated, not as a single comma-joined value.

namestring

New short name for the DIPP.

remove_iparray

One or more dedicated IP addresses to remove from the pool. Provide each IP as a separate array element — Mailgun's API accepts this parameter repeated, not as a single comma-joined value.

unlink_domainarray

One or more domain IDs to unlink from this DIPP. Provide each domain ID as a separate array element — Mailgun's API accepts this parameter repeated, not as a single comma-joined value.

addrstringrequired

The dedicated IP address to create a warmup plan for.

ipstringrequired

The IP address to assign to all account domains. Must belong to the account.

This tool takes no inputs.

addrstringrequired

The dedicated IP address to place into a band. Must belong to the account.

ip_bandstringrequired

The dedicated IP band to place the IP address into.

namestringrequired

The domain's INTERNAL ID (a Mongo ObjectID, e.g. 6a709fac9163aa838dac9844) — NOT the domain's DNS name. Live-confirmed: this endpoint rejects a DNS-style name with 'parsing domain id: the provided hex string is not a valid ObjectID'. Get the internal ID from mailgun_domains_get's or mailgun_domains_list's response (the 'id' field on the domain object).

pool_idstringrequired

The ID of the dedicated IP pool that spillover IPs are assigned to. Set to an empty string to disable DIPP spillover for this domain.

pool_idstringrequired

The ID of the dedicated IP pool that spillover IPs are assigned to, applied account-wide. Set to an empty string to disable DIPP spillover for the account.

all_subaccountsboolean

When true, applies the operation to every subaccount of the parent account asynchronously. Cannot be combined with subaccount_id.

link_iparray

Dedicated IP address(es) to link to the given subaccount(s). May be specified as an array with multiple values.

subaccount_idarray

One or more subaccount IDs to update. Required unless all_subaccounts is true. May be specified as an array with multiple values.

unlink_iparray

Dedicated IP address(es) to unlink from the given subaccount(s). May be specified as an array with multiple values.

comparatorstringrequired

The comparison operator used to evaluate the metric against the limit value.one of =!=<<=>>=

dimensionstringrequired

The dimension the metric is aggregated by (e.g. subaccount, domain, ip, ip_pool, recipient_provider).one of domainipip_poolrecipient_providersubaccount

limitstringrequired

The threshold limit value to compare the metric against. For limits this is typically a count, e.g. "2100".

metricstringrequired

The metric being monitored. For limit thresholds this tracks internal usage counts: email_preview_success_count (successful email previews) or seed_test_count (inbox placement tests).one of email_preview_success_countseed_test_count

namestringrequired

A user-friendly name for the limit threshold.

descriptionstring

A free-text description of what this limit does.

filtersarray

Optional list of filters to scope this limit to specific dimension values (e.g. only certain domains or subaccounts).

periodstring

The time period for the metric aggregation, in the format '1h', '1d', '1M', etc.

comparatorstringrequired

The comparison operator used to evaluate the metric against the limit value.one of =!=<<=>>=

dimensionstringrequired

The dimension the metric is aggregated by (e.g. subaccount, domain, ip, ip_pool, recipient_provider).one of domainipip_poolrecipient_providersubaccount

limitstringrequired

The threshold limit value to compare the metric against. For limits this is typically a count, e.g. "2100".

metricstringrequired

The metric being monitored. For limit thresholds this tracks internal usage counts: email_preview_success_count (successful email previews) or seed_test_count (inbox placement tests).one of email_preview_success_countseed_test_count

namestringrequired

The name of the existing limit threshold to update (used as the path identifier). This endpoint performs a full replacement, so it is also sent back as the resource's name in the update payload.

descriptionstring

A free-text description of what this limit does.

filtersarray

Optional list of filters to scope this limit to specific dimension values (e.g. only certain domains or subaccounts).

periodstring

The time period for the metric aggregation, in the format '1h', '1d', '1M', etc.

durationstring

A duration such as '1d' or '2h'. If provided, it is calculated from the end date and overwrites the start date.

endstring

End date/time for the query window, in RFC 2822 format. Defaults to the current time if omitted.

eventsarray

Restrict results to these event types.

filterobject

Advanced filter expression narrowing results. Shape: {"AND": [{"attribute": <field name, e.g. 'domain', 'recipient', 'tag'>, "comparator": "=", "values": [{"label": "...", "value": "..."}]}]}. Example: {"AND": [{"attribute": "domain", "comparator": "=", "values": [{"label": "example.com", "value": "example.com"}]}]}.

include_subaccountsboolean

Include logs from all subaccounts under this account.

include_totalsboolean

Include the total number of matching log entries in the response.

metric_eventsarray

Optional set of higher-level analytics metric events; these are converted internally into the corresponding raw events.

pagination_limitinteger

Maximum number of log entries to return (100 max).

pagination_sortstring

Colon-separated column name and sort direction, e.g. 'timestamp:asc'.

pagination_tokenstring

Opaque pagination token from a prior response, used to fetch the next page.

startstring

Start date/time for the query window, in RFC 2822 format. Defaults to 1 day before the current time if omitted.

list_addressstringrequired

The address of the mailing list to add members to, e.g. developers@mailgun.net.

membersstringrequired

Members to add, as a JSON-encoded array (passed as text). Provide either an array of plain email address strings, e.g. ["alice@example.com","bob@example.com"], or an array of member objects with fields address (required), name, vars (object of custom fields), and subscribed (boolean), e.g. [{"address":"alice@example.com","name":"Alice","subscribed":true}]. Up to 1000 members per call.

upsertboolean

If true, an existing member matching an address will be updated instead of causing an error. Defaults to false.default false

addressstringrequired

A valid email address for the new mailing list, e.g. developers@mailgun.net. May also include a display name, e.g. "Developers <devs@mg.net>".

access_levelstring

List access level: readonly (only admins can post), members (only list members can post), or everyone (anyone can post). Defaults to readonly.one of readonlymemberseveryonedefault readonly

descriptionstring

A free-text description of the mailing list.

namestring

Display name for the mailing list, e.g. Developers.

reply_preferencestring

Where replies to messages sent to this list should go: list (back to the mailing list) or sender (directly to the original sender). Defaults to list.one of listsenderdefault list

addressstringrequired

Valid email address of the member to add.

list_addressstringrequired

The address of the mailing list to add the member to, e.g. developers@mailgun.net.

namestring

An optional display name for the member.

subscribedboolean

Whether the member is subscribed. Defaults to true.default true

upsertboolean

If true, update the member if one with the same address already exists; if false, raise an error on a duplicate. Defaults to false.default false

varsstring

Optional custom variables for this member, as a JSON-ENCODED STRING (not a raw JSON object) of arbitrary key/value pairs, e.g. "{\"gender\":\"female\",\"age\":27}". Must be pre-serialized to a JSON string before passing it in — Mailgun's API only accepts this field as a string; a raw object value is silently dropped.

list_addressstringrequired

The current address of the mailing list to update, e.g. developers@mailgun.net.

access_levelstring

New access level for the list: readonly, members, or everyone. Leave unset to keep the current value (API default when creating is readonly).one of readonlymemberseveryone

addressstring

The new mailing list address, if you want to rename/change the list's address. Leave unset to keep the current address.

descriptionstring

New description for the mailing list. Leave unset to keep the current description.

list_idstring

Optional advanced List-Id override for the mailing list. Rarely needed; leave unset unless you specifically need to change this.

namestring

New display name for the mailing list. Leave unset to keep the current name.

reply_referencestring

Where replies to messages sent to this list should go: list (back to the mailing list) or sender (directly to the original sender). Leave unset to keep the current value.one of listsender

list_addressstringrequired

The address of the mailing list the member belongs to, e.g. developers@mailgun.net.

member_addressstringrequired

The current email address of the member to update.

addressstring

New email address for the member, if you want to change it. Leave unset to keep the current address.

namestring

New display name for the member. Leave unset to keep the current name.

subscribedboolean

Whether the member should be subscribed or not. Leave unset to keep the current subscription status.

varsstring

New custom variables for this member, as a JSON-ENCODED STRING (not a raw JSON object) of arbitrary key/value pairs, e.g. "{\"gender\":\"female\",\"age\":27}". Must be pre-serialized to a JSON string before passing it in — Mailgun's API only accepts this field as a string; a raw object value is silently dropped. Leave unset to keep the current values.

domain_namestringrequired

Domain name that was used to send the original email, e.g. mg.example.com.

storage_keystringrequired

Storage key from the email's associated events (e.g. an Accepted or Delivered event's `storage.key` field). Only available for the duration of the domain's message retention policy.

tostringrequired

Email address of the recipient(s) to resend the stored message to. Supports friendly name format, e.g. "Bob <bob@host.com>". Use commas to separate multiple recipients.

domain_namestringrequired

Domain name to send the email through, e.g. mg.example.com.

tostringrequired

Email address(es) of the recipient(s). For multiple recipients, separate addresses with a comma in this single value, e.g. "bob@host.com,alice@host.com" — do NOT pass a JSON array (Mailgun's form-encoded API expects one comma-joined value here, not repeated/indexed keys). Supports friendly name format, e.g. "Bob <bob@host.com>". Duplicate addresses are automatically ignored.

amp_htmlstring

AMP part of the message. Follow Google's AMP for Email guidelines when composing this content.

bccstring

Same as `to` but for blind carbon copy recipients. For multiple BCC recipients, separate addresses with a comma in this single value — do NOT pass a JSON array. Supports friendly name format.

ccstring

Same as `to` but for carbon copy recipients. For multiple CC recipients, separate addresses with a comma in this single value — do NOT pass a JSON array. Supports friendly name format.

fromstring

Email address for the From header. Can include a friendly name, e.g. "Excited User <mailgun@example.com>". Not required if sending with a template that has a pre-set From header (in which case this overrides it if provided); otherwise required.

htmlstring

Body of the message (HTML version). At least one of text, html, amp-html, or template is required.

o_archive_tostring

Sends a copy of the successfully delivered message as an HTTP POST (Content-Type application/mime) to this URL, containing exactly what the recipient's SMTP server received. Billed as a delivered message.

o_deliver_withinstring

Maximum time window for delivering the message, in `[0-9]+h[0-9]+m` format (e.g. `1h30m`, `30m`, `24h`), minimum 5m, maximum 24h. For scheduled messages, the window starts from the scheduled time.

o_deliverytimestring

Schedules delivery for a future time, in RFC-2822 format. Depending on your plan you can schedule up to 3 or 7 days in advance (or your domain's custom message_ttl).

o_deliverytime_optimize_periodstring

Toggles Send Time Optimization (STO) per message. Set to the number of hours in `[0-9]+h` format, min 24h, max 72h. Only available on certain plans.

o_dkimstring

Enables or disables DKIM signatures on a per-message basis, overriding the domain-level DKIM setting for this message.one of yesnotruefalse

o_require_tlsstring

If 'yes', requires the message to be sent only over a TLS connection; if TLS can't be established the message is not delivered. If 'no' (default), Mailgun attempts TLS but falls back to plaintext SMTP.one of yesnotruefalse

o_secondary_dkimstring

Specify a second domain key to sign the email with, formatted as `signing_domain/selector` (e.g. `example.com/s1`). The domain key must already exist and be activated.

o_secondary_dkim_publicstring

Alias of the domain key specified in Secondary DKIM, formatted as `public_signing_domain/selector`. Secondary DKIM must also be provided.

o_sending_ipstring

Specify a dedicated IP address (owned by your account) to send this message from.

o_sending_ip_poolstring

If provided, the email is delivered using an IP from this IP Pool ID.

o_skip_verificationstring

If 'yes', the certificate and hostname of the resolved MX host are not verified when establishing TLS. If 'no' (default), Mailgun verifies them and won't establish a TLS connection if verification fails.one of yesnotruefalse

o_suppress_headersstring

Removes specified X-Mailgun headers from the delivered message. Comma-separated header names, or 'all' to remove all X-Mailgun headers. Note: X-Mailgun-Sid is used to process complaints from feedback loops.

o_tagarray

Tag string(s) to attach to the message for tracking/analytics purposes. Up to 3 tags per message.

o_testmodestring

Enables sending in test mode: the message is processed normally but not actually delivered to recipients. Set to 'yes' to enable.one of yes

o_time_zone_localizestring

Toggles Timezone Optimization (TZO) per message. Set to the preferred delivery time in `HH:mm` (24h) or `hh:mmaa` (12h with AM/PM) format. Only available on certain plans.

o_trackingstring

Toggles both click and open tracking on a per-message basis, overriding the domain-level setting.one of yesnotruefalsehtmlonly

o_tracking_clicksstring

Toggles click tracking on a per-message basis, overriding the domain-level click-tracking setting. 'htmlonly' rewrites links only in the HTML part.one of yesnotruefalsehtmlonly

o_tracking_opensstring

Toggles open tracking on a per-message basis. Has higher priority than the domain-level setting.one of yesnotruefalse

o_tracking_pixel_location_topstring

Places the open-tracking pixel at the top of the email instead of the bottom. Useful for long emails that may be truncated or have rendering issues.one of yesnotruefalsehtmlonly

recipient_variablesstring

A JSON-encoded dictionary for batch sending with personalized variables per recipient. Each key is a recipient email address; each value is a dictionary of variables for that recipient, referenced in the message as %recipient.variablename%. Maximum 1,000 recipients per batch.

reply_tostring

Sets a Reply-To header on the message via Mailgun's custom-header mechanism (sent as the `h:Reply-To` form field). This is the only individually-addressable custom header exposed by this tool; Mailgun's general h:<Header-Name> mechanism for arbitrary custom headers is not otherwise supported because it requires a dynamic field name that this tool's fixed set of inputs can't represent.

subjectstring

Message subject. Not required if sending with a template that has a pre-set Subject header (in which case this overrides it if provided); otherwise a subject or a template with a preset subject is expected.

t_textstring

Generates a plain-text version of the template alongside the HTML version. Set to 'yes' to have Mailgun create a text/plain MIME part from the template content, improving deliverability/accessibility.one of yes

t_variablesstring

A valid JSON-encoded dictionary used as input for template variable expansion.

t_versionstring

Render a specific version of the given template instead of the latest version. The `template` field must also be provided.

templatestring

Name of a template stored via the Templates API to use to render the email body. If provided, text/html/amp-html are optional.

textstring

Body of the message (plain-text version). At least one of text, html, amp-html, or template is required.

dimensionsarray

Attributes to break the metric data down by, e.g. 'domain' or 'time'.

durationstring

A duration such as '1d', '2h', or '2m'. If provided, it is calculated from the end date and overwrites the start date.

endstring

End date/time for the query window, in RFC 2822 format. Defaults to the current time if omitted.

filterobject

Advanced filter expression narrowing results. Shape: {"AND": [{"attribute": <field name, e.g. 'domain', 'tag', 'subaccount'>, "comparator": "=", "values": [{"label": "...", "value": "..."}]}]}. Example: {"AND": [{"attribute": "domain", "comparator": "=", "values": [{"label": "example.com", "value": "example.com"}]}]}.

include_aggregatesboolean

Include top-level aggregate metrics in addition to the dimensioned breakdown.

include_subaccountsboolean

Include stats from all subaccounts under this account.

metricsarray

Names of the metrics to return, e.g. 'accepted_count', 'delivered_count', 'clicked_rate'. Provide at least one metric to get meaningful results.

resolutionstring

Time bucket resolution for the returned metrics, e.g. 'day', 'hour', or 'month'. Defaults to 'day' if omitted.one of dayhourmonth

startstring

Start date/time for the query window, in RFC 2822 format. Defaults to 7 days before the current time if omitted.

dimensionsarray

Attributes to break the usage metric data down by: 'subaccount' or 'time'.

durationstring

A duration such as '1d', '2h', or '2m'. If provided, it is calculated from the end date and overwrites the start date.

endstring

End date/time for the query window, in RFC 2822 format. Defaults to the current time if omitted.

filterobject

Advanced filter expression narrowing results. Shape: {"AND": [{"attribute": <field name, e.g. 'subaccount'>, "comparator": "=", "values": [{"label": "...", "value": "..."}]}]}. Example: {"AND": [{"attribute": "subaccount", "comparator": "=", "values": [{"label": "12345", "value": "12345"}]}]}.

include_aggregatesboolean

Include top-level aggregate usage metrics in addition to the dimensioned breakdown.

include_subaccountsboolean

Include usage stats from all subaccounts under this account.

metricsarray

Names of the usage metrics to return, e.g. 'email_validation_count', 'seed_test_count'. Provide at least one metric to get meaningful results.

resolutionstring

Time bucket resolution for the returned metrics, e.g. 'day', 'hour', or 'month'. Defaults to 'day' if omitted.one of dayhourmonth

startstring

Start date/time for the query window, in RFC 2822 format. Defaults to 7 days before the current time if omitted.

expressionstringrequired

The filtering rule that determines when this route's actions fire, written using Mailgun's route-expression syntax (e.g. match_recipient, match_header, catch_all).

actionarray

One or more actions to execute when the expression evaluates to true, e.g. forward("url"), store(), stop(). You can pass multiple actions.

descriptionstring

An arbitrary human-readable description for this route.

priorityinteger

Smaller number indicates higher priority; higher-priority routes are evaluated first. Defaults to 0.default 0

idstringrequired

ID of the route to update.

actionarray

One or more actions to execute when the expression evaluates to true. Only updates this field if provided.

descriptionstring

An arbitrary human-readable description for this route. Only updates this field if provided.

expressionstring

The filtering rule that determines when this route's actions fire. Only updates this field if provided.

priorityinteger

Smaller number indicates higher priority; higher-priority routes are evaluated first. Only updates this field if provided.