mailgun
Mailgun API for email delivery and automation
Actions (144)
Bounce Classification · 16
- List bounce-classification config entitiesGET /v1/bounce-classification/config/entities
Deprecated configuration entities for bounce classification.
documented - List bounce-classification config entitiesGET /v1/bounce-classification/config/entities
Deprecated configuration entities for bounce classification.
documented - List bounce-classification config rulesGET /v1/bounce-classification/config/rules
Deprecated configuration rules for bounce classification.
documented - List bounce-classification config rulesGET /v1/bounce-classification/config/rules
Deprecated configuration rules for bounce classification.
documented - List bounce-classification domainsGET /v1/bounce-classification/domains
Deprecated domain list for bounce classification.
documented - List bounce-classification domainsGET /v1/bounce-classification/domains
Deprecated domain list for bounce classification.
documented - List bounce-classification statsGET /v1/bounce-classification/stats
Deprecated stats endpoint for bounce classification.
documented - List bounce-classification statsGET /v1/bounce-classification/stats
Deprecated stats endpoint for bounce classification.
documented - List domain entities (bounce classification)GET /v1/bounce-classification/domains/{domain}/entities
Deprecated entities for a domain in bounce classification.
documented - List domain entities for bounce classificationGET /v1/bounce-classification/domains/{domain}/entities
Deprecated entities for a domain in bounce classification.
documented - List domain entity rulesGET /v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules
Deprecated rules for a domain entity in bounce classification.
documented - List domain entity rules (bounce classification)GET /v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules
Deprecated rules for a domain entity in bounce classification.
documented - List domain eventsGET /v1/bounce-classification/domains/{domain}/events
Deprecated events for a domain in bounce classification.
documented - List domain events (bounce classification)GET /v1/bounce-classification/domains/{domain}/events
Deprecated events for a domain in bounce classification.
documented - Submit bounce-classification metricsPOST /v2/bounce-classification/metrics
Submit bounce-classification metrics.
documented - Submit bounce-classification metricsPOST /v2/bounce-classification/metrics
Submit metrics to bounce-classification.
documented
IP Pools · 9
- Assign domain to IPPOST /v3/domains/{name}/ips/{ip}
Assign a domain to an IP.
documented - Create IP poolPOST /v3/ip_pools
Create an IP pool.
documented - Delete IP poolDELETE /v3/ip_pools/{pool_id}
Delete an IP pool.
documented - Get IP poolGET /v3/ip_pools/{pool_id}
Retrieve an IP pool by ID.
documented - List IP poolsGET /v3/ip_pools
List IP pools.
documented - List domains in IP poolGET /v3/ip_pools/{pool_id}/domains
List domains assigned to an IP pool.
documented - Remove IP from poolDELETE /v3/domains/{name}/pool/{ip}
Remove an IP from a pool.
documented - Remove domain from IPDELETE /v3/domains/{name}/ips/{ip}
Remove a domain from an IP.
documented - Update IP poolPATCH /v3/ip_pools/{pool_id}
Update an IP pool.
documented
Mailing Lists · 9
- Add mailing list memberPOST /v3/lists/{list_address}/members
Add a member to a mailing list.
documented - Add mailing list member (CSV)POST /v3/lists/{list_address}/members.csv
Add a member to a mailing list via CSV payload.
documented - Add mailing list member (JSON)POST /v3/lists/{list_address}/members.json
Add a member to a mailing list via JSON payload.
documented - Create mailing listPOST /v3/lists
Create a new mailing list.
documented - Delete mailing list memberDELETE /v3/lists/{list_address}/members/{member_address}
Delete a member from a mailing list.
documented - Get mailing list memberGET /v3/lists/{list_address}/members/{member_address}
Retrieve a mailing list member.
documented - List mailing list membersGET /v3/lists/{list_address}/members
List members of a mailing list.
documented - List mailing listsGET /v3/lists
List all mailing lists.
documented - Update mailing list memberPUT /v3/lists/{list_address}/members/{member_address}
Update a mailing list member.
documented
Account Management · 8
- Create HTTP signing keyPOST /v5/accounts/http_signing_key
Create an HTTP signing key for the account.
documented - Create sandbox auth recipientPOST /v5/sandbox/auth_recipients
Create a sandbox authentication recipient.
documented - Delete sandbox auth recipientDELETE /v5/sandbox/auth_recipients/{email}
Delete a sandbox authentication recipient by email.
documented - Get HTTP signing keyGET /v5/accounts/http_signing_key
Retrieve the HTTP signing key for the account.
documented - Get accountGET /v5/accounts
Retrieve account information.
documented - List sandbox auth recipientsGET /v5/sandbox/auth_recipients
List sandbox authentication recipients.
documented - Resend activation emailPOST /v5/accounts/resend_activation_email
Resend the activation email for the account.
documented - Update accountPUT /v5/accounts
Update account information at the account level.
documented
Domain Keys · 8
- Activate DKIM keyPUT /v4/domains/{authority_name}/keys/{selector}/activate
Activate a DKIM key for a domain authority.
documented - Create DKIM keyPOST /v1/dkim/keys
Create a new DKIM key.
documented - Deactivate DKIM keyPUT /v4/domains/{authority_name}/keys/{selector}/deactivate
Deactivate a DKIM key.
documented - Delete DKIM keyDELETE /v1/dkim/keys
Delete a DKIM key.
documented - List DKIM keysGET /v1/dkim/keys
List DKIM keys at the account level.
documented - List DKIM keys (domain)GET /v4/domains/{authority_name}/keys
List DKIM keys for a domain authority.
documented - Update DKIM authorityPUT /v3/domains/{name}/dkim_authority
Update DKIM authority for a domain.
documented - Update DKIM selectorPUT /v3/domains/{name}/dkim_selector
Update DKIM selector for a domain.
documented
Domain Webhooks · 8
- Create domain webhookPOST /v3/domains/{domain}/webhooks
Create a new webhook for a domain.
documented - Create domain webhook (v4)POST /v4/domains/{domain}/webhooks
Create a new domain webhook (v4).
documented - Delete domain webhookDELETE /v3/domains/{domain_name}/webhooks/{webhook_name}
Delete a domain webhook.
documented - Delete domain webhooks (v4)DELETE /v4/domains/{domain}/webhooks
Delete all domain webhooks (v4).
documented - Get domain webhookGET /v3/domains/{domain_name}/webhooks/{webhook_name}
Retrieve a specific domain webhook by name.
documented - List domain webhooksGET /v3/domains/{domain}/webhooks
Retrieve webhooks for a domain.
documented - Update domain webhookPUT /v3/domains/{domain_name}/webhooks/{webhook_name}
Update a domain webhook.
documented - Update domain webhooks (v4)PUT /v4/domains/{domain}/webhooks
Update domain webhooks using v4 API.
documented
Subaccounts · 8
- Create subaccountPOST /v5/accounts/subaccounts
Create a new subaccount.
documented - Delete subaccountsDELETE /v5/accounts/subaccounts
Delete all subaccounts.
documented - Disable subaccountPOST /v5/accounts/subaccounts/{subaccount_id}/disable
Disable a subaccount.
documented - Enable subaccountPOST /v5/accounts/subaccounts/{subaccount_id}/enable
Enable a subaccount.
documented - Get subaccountGET /v5/accounts/subaccounts/{subaccount_id}
Retrieve a subaccount by ID.
documented - Get subaccount monthly custom limitGET /v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly
Retrieve the monthly custom limit for a subaccount.
documented - List subaccountsGET /v5/accounts/subaccounts
List all subaccounts.
documented - Update subaccount monthly custom limitPUT /v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly
Update the subaccount's monthly custom limit.
documented
Templates · 8
- Create templatePOST /v3/{domain_name}/templates
Create a template for a domain.
documented - Create template versionPOST /v3/{domain_name}/templates/{template_name}/versions
Create a new version of a template.
documented - Delete templateDELETE /v3/{domain_name}/templates/{template_name}
Delete a template.
documented - Delete templatesDELETE /v3/{domain_name}/templates
Delete templates for a domain.
documented - Get templateGET /v3/{domain_name}/templates/{template_name}
Retrieve a specific template.
documented - List template versionsGET /v3/{domain_name}/templates/{template_name}/versions
List versions of a template.
documented - List templatesGET /v3/{domain_name}/templates
List templates for a domain.
documented - Update templatePUT /v3/{domain_name}/templates/{template_name}
Update a template.
documented
Domain Tracking · 7
- Activate X.509 for domainPUT /v2/x509/{domain}
Activate X.509 certificate for domain.
documented - Enable tracking for clicksPUT /v3/domains/{name}/tracking/click
Enable click tracking for a domain.
documented - Enable tracking for opensPUT /v3/domains/{name}/tracking/open
Enable open tracking for a domain.
documented - Enable tracking for unsubscribePUT /v3/domains/{name}/tracking/unsubscribe
Enable unsubscribe tracking for a domain.
documented - Get X.509 statusGET /v2/x509/{domain}/status
Get TLS/SSL status for the domain certificate.
documented - Get domain trackingGET /v3/domains/{name}/tracking
Retrieve tracking status for a domain.
documented - Renew X.509 for domainPOST /v2/x509/{domain}
Renew X.509 certificate for domain.
documented
Account Webhooks · 6
- Create account webhookPOST /v1/webhooks
Create a new account-level webhook.
documented - Delete account webhookDELETE /v1/webhooks/{webhook_id}
Delete a specific account webhook.
documented - Delete account webhooksDELETE /v1/webhooks
Delete all account webhooks.
documented - Get account webhookGET /v1/webhooks/{webhook_id}
Retrieve a specific account webhook by ID.
documented - List account webhooksGET /v1/webhooks
Retrieve account-wide webhook configurations.
documented - Update account webhookPUT /v1/webhooks/{webhook_id}
Update a specific account webhook.
documented
Domains · 6
- Create domainPOST /v4/domains
Create a new sending domain.
documented - Delete domainDELETE /v3/domains/{name}
Delete the specified domain.
documented - Get domainGET /v4/domains/{name}
Retrieve domain details for the given domain.
documented - List domainsGET /v4/domains
Retrieve a list of domains in the account (US/EU depending on region).
documented - Update domainPUT /v4/domains/{name}
Update settings for the given domain.
documented - Verify domainPUT /v4/domains/{name}/verify
Verify domain DNS settings for Mailgun.
documented
Messages · 6
- Delete domain envelopesDELETE /v3/{domain_name}/envelopes
Delete envelopes for the domain.
documented - List domain sending queuesGET /v3/domains/{name}/sending_queues
List sending queues for the domain.
documented - Reprocess stored messagePOST /v3/domains/{domain_name}/messages/{storage_key}
Submit or reprocess a stored message by its storage key (semantics documented in API).
documented - Retrieve stored messageGET /v3/domains/{domain_name}/messages/{storage_key}
Retrieve a previously stored outgoing message by its storage key.
documented - Send MIME messagePOST /v3/{domain_name}/messages.mime
Submit a prebuilt MIME message for delivery to the specified domain.
documented - Send messagePOST /v3/{domain_name}/messages
Send an email using the Mailgun REST API for the specified domain.
documented
Routes · 6
- Create routePOST /v3/routes
Create a new route for incoming mail.
documented - Delete routeDELETE /v3/routes/{id}
Delete a route.
documented - Get routeGET /v3/routes/{id}
Retrieve a specific route by ID.
documented - List routesGET /v3/routes
Retrieve all routes.
documented - Match routeGET /v3/routes/match
Match routes for an incoming message.
documented - Update routePUT /v3/routes/{id}
Update a route.
documented
Credentials · 5
- Create domain credentialPOST /v3/domains/{domain_name}/credentials
Create SMTP credentials for a domain.
documented - Delete domain credentialDELETE /v3/domains/{domain_name}/credentials/{spec}
Delete a specific domain credential.
documented - Delete domain credentialsDELETE /v3/domains/{domain_name}/credentials
Delete SMTP credentials for a domain.
documented - List domain credentialsGET /v3/domains/{domain_name}/credentials
List SMTP credentials for a domain.
documented - Update domain credentialPUT /v3/domains/{domain_name}/credentials/{spec}
Update a domain credential specification.
documented
IPs · 5
- Assign domain to IP (alternate path)POST /v3/ips/{ip}/domains
Associate a domain with an IP.
documented - Detach domain from IPDELETE /v3/ips/{ip}/domains
Detach a domain from an IP.
documented - Get IPGET /v3/ips/{ip}
Get details for a specific IP.
documented - List IPsGET /v3/ips
List all IP addresses.
documented - List domains on IPGET /v3/ips/{ip}/domains
List domains associated with an IP.
documented
Custom Message Limit · 4
- Delete global monthly custom limitDELETE /v5/accounts/limit/custom/monthly
Delete the global monthly custom limit.
documented - Enable global custom monthly limitPUT /v5/accounts/limit/custom/enable
Enable the global custom monthly limit.
documented - Get global custom monthly limitGET /v5/accounts/limit/custom/monthly
Get the global monthly custom message limit.
documented - Set global monthly custom limitPUT /v5/accounts/limit/custom/monthly
Set the global monthly custom message limit.
documented
IP Address Warmup · 4
- Get IP warmupGET /v3/ip_warmups/{addr}
Get IP warmup details for an address.
documented - List IP warmupsGET /v3/ip_warmups
List IP warmup records.
documented - Start IP warmingPOST /v3/ip_warmups/{addr}
Start IP warming for an address.
documented - Stop IP warmingDELETE /v3/ip_warmups/{addr}
Stop IP warming for an address.
documented
IP Allowlist · 4
- Add IP to allowlistPOST /v2/ip_whitelist
Add an IP to the allowlist.
documented - Clear IP allowlistDELETE /v2/ip_whitelist
Clear all IP allowlist entries.
documented - List IP allowlistGET /v2/ip_whitelist
List allowed IP addresses.
documented - Update IP allowlistPUT /v2/ip_whitelist
Update IP allowlist entries.
documented
Keys · 4
Metrics · 4
- Send metricsPOST /v1/analytics/metrics
Submit metrics data for analytics.
documented - Send usage metricsPOST /v1/analytics/usage/metrics
Submit usage metrics for analytics.
documented - Submit analytics metricsPOST /v1/analytics/metrics
Submit metrics data for analytics processing.
documented - Submit usage metricsPOST /v1/analytics/usage/metrics
Submit usage metrics for analytics processing.
documented