{"openapi":"3.0.0","info":{"description":"Email API service","version":[{"name":"v1","value":"v1"},{"name":"v2","value":"v2"},{"name":"v3","value":"v3"},{"name":"v4","value":"v4"}]},"servers":[{"description":"Email API service","url":"https://api.apirails.com/mailgun"}],"paths":{"/v3/{domain_name}/messages":{"post":{"tags":["Messages"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name used to send the message","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/messages"},"summary":"Send an email","description":"Send an email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"from":{"type":"string","description":"Email address of the `From` header. Can include a friendly name using the format `\"Friendly Name <email@domain.com>\"`. Note: not required if sending with a template that has a pre-set From header, but will override the template's From header if provided.","required":true},"to":{"type":"string","description":"Email address of the recipient(s). Supports friendly name format. Example: `\"Bob <bob@host.com>\"`. Use commas to separate multiple recipients. Duplicate addresses are automatically ignored.","required":true},"cc":{"type":"string","description":"Same as `to` but for carbon copy recipients. Supports friendly name format."},"bcc":{"type":"string","description":"Same as `to` but for blind carbon copy recipients. Supports friendly name format."},"subject":{"type":"string","description":"Message subject. Note: not required if sending with a template that has a pre-set Subject header, but it will override it if provided.","required":true},"text":{"type":"string","description":"Body of the message (text version)"},"html":{"type":"string","description":"Body of the message (HTML version)"},"amp-html":{"type":"string","description":"AMP part of the message.  Please follow Google guidelines to compose and send AMP emails"},"attachment":{"type":"string","format":"binary","description":"File attachment.  You can post multiple `attachment` values.  **Important:** You must use `multipart/form-data` encoding for sending attachments"},"inline":{"type":"string","format":"binary","description":"Attachment with `inline` disposition.  Can be used to send inline images (see example). You can post multiple `inline` values"},"template":{"type":"string","description":"Name of a template stored via the Templates API to use to render the email body. See [Templates](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates) for more information"},"t:version":{"type":"string","description":"Render a specific version of the given template instead of the latest version. `template` option must also be provided."},"t:text":{"type":"string","description":"Generates a plain text version of the template alongside the HTML version when sending templated emails. When set to 'yes', instructs Mailgun to create a text/plain MIME part based on the template content, ensuring compatibility with email clients that don't support HTML or have HTML rendering disabled. This improves email deliverability and accessibility by providing a fallback text version in multipart emails."},"t:variables":{"type":"string","description":"A valid JSON-encoded dictionary used as the input for template variable expansion.  See [Templates](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates) for more information"},"o:tag":{"type":"array","description":"Tag string.  See [Tagging](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/track-tagging) for more information","items":{"type":"string"}},"o:dkim":{"type":"string","description":"Enables or disables DKIM signatures on a per-message basis. Overrides the domain-level DKIM setting for this specific message."},"o:secondary-dkim":{"type":"string","description":"Specify a second domain key to sign the email with. The value is formatted as `signing_domain/selector`, e.g. `example.com/s1`. This tells Mailgun to sign the message with the signing domain `example.com` using the selector `s1`. Note: the domain key specified must have been previously created and activated."},"o:secondary-dkim-public":{"type":"string","description":"Specify an alias of the domain key specified in `o:secondary-dkim`. Also formatted as `public_signing_domain/selector`. `o:secondary-dkim` option must also be provided. Mailgun will sign the message with the provided key of the secondary DKIM, but use the public secondary DKIM name and selector. Note: We will perform a DNS check prior to signing the message to ensure the public keys matches the secondary DKIM."},"o:deliverytime":{"type":"string","description":"Specifies the scheduled delivery time in [RFC-2822 format](https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format). Depending on your plan, you can schedule messages up to 3 or 7 days in advance. If your domain has a custom message_ttl (time-to-live) setting, this value determines the maximum scheduling duration. Example: 'Fri, 14 Oct 2011 12:00:00 +0000'"},"o:deliver-within":{"type":"string","description":"Specifies the maximum time window for delivering the message. Accepts values in format `[0-9]+h[0-9]+m` (e.g., `1h30m`, `30m`, `24h`), with a minimum of `5m` and maximum of `24h`. For scheduled messages, the delivery window starts from the scheduled time. The standard retry schedule applies within this window, so shorter timeframes may result in fewer delivery attempts."},"o:deliverytime-optimize-period":{"type":"string","description":"Toggles Send Time Optimization (STO) on a per-message basis.  String should be set to the number of hours in `[0-9]+h` format, with the minimum being `24h` and the maximum being `72h`.  This value defines the time window in which Mailgun will run the optimization algorithm based on prior engagement data of a given recipient. See [Sending a Message with STO](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-sto) for details. *Please note that STO is only available on certain plans. See www.mailgun.com/pricing for more info*"},"o:time-zone-localize":{"type":"string","description":"Toggles Timezone Optimization (TZO) on a per message basis. String should be set to preferred delivery time in `HH:mm` or `hh:mmaa` format, where `HH:mm` is used for 24 hour format without AM/PM and hh:mmaa is used for 12 hour format with AM/PM. See [Sending a Message with TZO](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-tzo) for details. *Please note that TZO is only available on certain plans. See www.mailgun.com/pricing for more info*"},"o:testmode":{"type":"string","description":"Enables sending in test mode. Messages are processed normally but not actually delivered to recipients. Useful for testing without sending real emails. See [Sending in Test Mode](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/test-mode)"},"o:tracking":{"type":"string","description":"Toggles both click and open tracking on a per-message basis"},"o:tracking-clicks":{"type":"string","description":"Toggles click tracking on a per-message basis, see [Tracking Clicks](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-clicks).  This overrides the domain-level click tracking setting."},"o:tracking-opens":{"type":"string","description":"Toggles opens tracking on a per-message basis, see [Tracking Opens](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-opens).  Has higher priority than domain-level setting."},"o:require-tls":{"type":"string","description":"When set to 'yes', requires the message to be sent only over a TLS connection to the Email Service Provider. If TLS cannot be established, the message will not be delivered. When set to 'no' (default), Mailgun attempts TLS but falls back to plaintext SMTP if needed."},"o:skip-verification":{"type":"string","description":"If `true`, the certificate and hostname of the resolved MX Host will not be verified when trying to establish a TLS connection. If `false`, Mailgun will verify the certificate and hostname. If either one can not be verified, a TLS connection will not be established. The default is `false`"},"o:sending-ip":{"type":"string","description":"Used to specify an IP Address to send an email that is owned by your account"},"o:sending-ip-pool":{"type":"string","description":"If an IP Pool ID is provided, the email will be delivered with an IP that belongs in that pool"},"o:tracking-pixel-location-top":{"type":"string","description":"Places the tracking pixel at the top of emails instead of the bottom. Useful for long emails that may be truncated or have rendering issues, ensuring open tracking works accurately."},"o:archive-to":{"type":"string","description":"Sends a copy of successfully delivered messages to the specified URL via HTTP POST. The request uses Content-Type: application/mime and contains the exact message the recipient's SMTP server received. NOTE: These are accounted for and billed as delivered messages"},"o:suppress-headers":{"type":"string","description":"Removes specified X-Mailgun headers from the delivered message. Provide header names separated by commas (e.g., 'X-Mailgun-Variables,X-Mailgun-Tag') or use 'all' to remove all X-Mailgun headers.Note: X-Mailgun-Sid header is currently used to process complains received via feedback loops."},"h:X-My-Header":{"type":"string","description":"Adds custom headers to the email. Use 'h:' prefix followed by header name and value. Example: 'h:X-Custom-Header=my-value'"},"v:my-var":{"type":"string","description":"Attaches custom data to the message using the 'v:' prefix followed by a variable name. When sending with templates, provides values for template variable substitution (overridden by 't:variables' if both are provided). When not using templates, treated as metadata and included in events/webhooks. Variables are visible in the delivered email's X-Mailgun-Variables header. Example: 'v:user-id=123'. NOTE: Anything over 4KB will be truncated in the event/webhooks."},"recipient-variables":{"type":"string","description":"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. Variables can be referenced in the message using %recipient.variablename%. Example: '{\"alice@example.com\": {\"name\":\"Alice\", \"id\":1}, \"bob@example.com\": {\"name\":\"Bob\", \"id\":2}}'. Maximum 1,000 recipients per batch. See [Batch Sending](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/batch-sending) for more information"}}},"example":{"from":"","to":"","cc":"","bcc":"","subject":"","text":"","html":"","amp-html":"","attachment":["file.pdf","image.png"],"inline":["logo.png"],"template":"","t:version":"","t:text":"","t:variables":"","o:tag":["newsletter","transactional"],"o:dkim":"","o:secondary-dkim":"","o:secondary-dkim-public":"","o:deliverytime":"","o:deliver-within":"","o:deliverytime-optimize-period":"","o:time-zone-localize":"","o:testmode":"","o:tracking":"","o:tracking-clicks":"","o:tracking-opens":"","o:require-tls":"","o:skip-verification":"","o:sending-ip":"","o:sending-ip-pool":"","o:tracking-pixel-location-top":"","o:archive-to":"","o:suppress-headers":"","h:X-My-Header":"","v:my-var":"","recipient-variables":""}}}}}},"/v3/{domain_name}/messages.mime":{"post":{"tags":["Messages"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name used to send the message","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages-mime.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/messages.mime"},"summary":"Send an email in MIME format","description":"Send an email in MIME format","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"to":{"type":"array","description":"Email address of the recipient(s). Supports friendly name format. Example: `\"Bob <bob@host.com>\"`. Use commas to separate multiple recipients. Duplicate addresses are automatically ignored.","required":true,"items":{"type":"string"}},"message":{"type":"string","description":"MIME string of the message.  Make sure to use `multipart/form-data` content type to send this as a file upload","required":true},"template":{"type":"string","description":"Name of a template stored via template API to use to render the email body. See [Templates](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates) for more information"},"t:version":{"type":"string","description":"Render a specific version of the given template instead of the latest version. `template` option must also be provided."},"t:text":{"type":"string","description":"Generates a plain text version of the template alongside the HTML version when sending templated emails. When set to 'yes', instructs Mailgun to create a text/plain MIME part based on the template content, ensuring compatibility with email clients that don't support HTML or have HTML rendering disabled. This improves email deliverability and accessibility by providing a fallback text version in multipart emails."},"t:variables":{"type":"string","description":"A valid JSON-encoded dictionary used as the input for template variable expansion. See [Templates](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates) for more information"},"o:tag":{"type":"array","description":"Tag string.  See [Tags](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/track-tagging) for more information","items":{"type":"string"}},"o:dkim":{"type":"string","description":"Enables or disables DKIM signatures on a per-message basis. Overrides the domain-level DKIM setting for this specific message."},"o:secondary-dkim":{"type":"string","description":"Specify a second domain key to sign the email with. The value is formatted as `signing_domain/selector`, e.g. `example.com/s1`. This tells Mailgun to sign the message with the signing domain `example.com` using the selector `s1`. Note: the domain key specified must have been previously created and activated."},"o:secondary-dkim-public":{"type":"string","description":"Specify an alias of the domain key specified in `o:secondary-dkim`. Also formatted as `public_signing_domain/selector`. `o:secondary-dkim` option must also be provided. Mailgun will sign the message with the provided key of the secondary DKIM, but use the public secondary DKIM name and selector. Note: We will perform a DNS check prior to signing the message to ensure the public keys matches the secondary DKIM."},"o:deliverytime":{"type":"string","description":"Specifies the scheduled delivery time in [RFC-2822 format](https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format). Depending on your plan, you can schedule messages up to 3 or 7 days in advance. If your domain has a custom message_ttl (time-to-live) setting, this value determines the maximum scheduling duration. Example: 'Fri, 14 Oct 2011 12:00:00 +0000'"},"o:deliver-within":{"type":"string","description":"Specifies the maximum time window for delivering the message. Accepts values in format `[0-9]+h[0-9]+m` (e.g., `1h30m`, `30m`, `24h`), with a minimum of `5m` and maximum of `24h`. For scheduled messages, the delivery window starts from the scheduled time. The standard retry schedule applies within this window, so shorter timeframes may result in fewer delivery attempts."},"o:deliverytime-optimize-period":{"type":"string","description":"Toggles Send Time Optimization (STO) on a per-message basis.  String should be set to the number of hours in `[0-9]+h` format, with the minimum being `24h` and the maximum being `72h`.  This value defines the time window in which Mailgun will run the optimization algorithm based on prior engagement data of a given recipient.  See [Sending a Message with STO](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-sto) for details. *Please note that STO is only available on certain plans. See www.mailgun.com/pricing for more info*"},"o:time-zone-localize":{"type":"string","description":"Toggles Timezone Optimization (TZO) on a per message basis. String should be set to preferred delivery time in `HH:mm` or `hh:mmaa` format, where `HH:mm` is used for 24 hour format without AM/PM and hh:mmaa is used for 12 hour format with AM/PM. See [Sending a Message with TZO](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-tzo) for details.  *Please note that TZO is only available on certain plans. See www.mailgun.com/pricing for more info*"},"o:testmode":{"type":"string","description":"Enables sending in test mode. Messages are processed normally but not actually delivered to recipients. Useful for testing without sending real emails. See [Sending in Test Mode](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/test-mode)"},"o:tracking":{"type":"string","description":"Toggles both click and open tracking on a per-message basis, see [Tracking Messages](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages) for details."},"o:tracking-clicks":{"type":"string","description":"Toggles click tracking on a per-message basis, see [Tracking Clicks](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-clicks).  This overrides the domain-level click tracking setting"},"o:tracking-opens":{"type":"string","description":"Toggles opens tracking on a per-message basis, see [Tracking Opens](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/tracking-opens). Has higher priority than domain-level setting."},"o:require-tls":{"type":"string","description":"When set to 'yes', requires the message to be sent only over a TLS connection. If TLS cannot be established, the message will not be delivered. When set to 'no' (default), Mailgun attempts TLS but falls back to plaintext SMTP if needed."},"o:skip-verification":{"type":"string","description":"When set to 'true', skips certificate and hostname verification for TLS connections. When 'false' (default), Mailgun verifies certificates and hostnames - if verification fails, TLS connection is not established."},"o:sending-ip":{"type":"string","description":"Used to specify an IP Address to send an email that is owned by your account"},"o:sending-ip-pool":{"type":"string","description":"If an IP Pool ID is provided, the email will be delivered with an IP that belongs in that pool"},"o:tracking-pixel-location-top":{"type":"string","description":"Places the tracking pixel at the top of emails instead of the bottom. Useful for long emails that may be truncated or have rendering issues, ensuring open tracking works accurately."},"o:archive-to":{"type":"string","description":"Sends a copy of successfully delivered messages to the specified URL via HTTP POST. The request uses Content-Type: application/mime and contains the exact message the recipient's SMTP server received. NOTE: These are accounted for and billed as delivered messages"},"o:suppress-headers":{"type":"string","description":"Removes specified X-Mailgun headers from the delivered message. Provide header names separated by commas (e.g., 'X-Mailgun-Variables,X-Mailgun-Tag') or use 'all' to remove all X-Mailgun headers.Note: X-Mailgun-Sid header is currently used to process complains received via feedback loops."},"h:X-My-Header":{"type":"string","description":"Adds custom headers to the email. Use 'h:' prefix followed by header name and value. Example: 'h:X-Custom-Header=my-value'"},"v:my-var":{"type":"string","description":"Attaches custom data to the message using the 'v:' prefix followed by a variable name. When sending with templates, provides values for template variable substitution (overridden by 't:variables' if both are provided). When not using templates, treated as metadata and included in events/webhooks. Variables are visible in the delivered email's X-Mailgun-Variables header. Example: 'v:user-id=123'.NOTE: Anything over 4KB will be truncated in the event/webhooks"},"recipient-variables":{"type":"string","description":"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. Variables can be referenced in the message using %recipient.variablename%. Example: '{\"alice@example.com\": {\"name\":\"Alice\", \"id\":1}, \"bob@example.com\": {\"name\":\"Bob\", \"id\":2}}'. Maximum 1,000 recipients per batch. See [Batch Sending](https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/batch-sending) for more information."}}},"example":{"to":["bob@host.com","Alice <alice@example.com>"],"message":"","template":"","t:version":"","t:text":"","t:variables":"","o:tag":["newsletter","transactional"],"o:dkim":"","o:secondary-dkim":"","o:secondary-dkim-public":"","o:deliverytime":"","o:deliver-within":"","o:deliverytime-optimize-period":"","o:time-zone-localize":"","o:testmode":"","o:tracking":"","o:tracking-clicks":"","o:tracking-opens":"","o:require-tls":"","o:skip-verification":"","o:sending-ip":"","o:sending-ip-pool":"","o:tracking-pixel-location-top":"","o:archive-to":"","o:suppress-headers":"","h:X-My-Header":"","v:my-var":"","recipient-variables":""}}}}}},"/v3/domains/{domain_name}/messages/{storage_key}":{"get":{"tags":["Messages"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name that was used to send the email","required":true,"schema":{"type":"string","example":""}},{"name":"storage_key","in":"path","description":"Storage key from the email's associated events (Example: Accepted/Delivered events `storage.key` field). Note: Storage keys are available for the duration of your domain's message retention policy.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--domain-name--messages--storage-key-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/messages/{storage_key}"},"summary":"Retrieve a stored email","description":"Retrieve a stored email","security":[{"bearerAuth":[]}]},"post":{"tags":["Messages"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name used to send the message","required":true,"schema":{"type":"string","example":""}},{"name":"storage_key","in":"path","description":"Storage key from the email's associated events (Example: Accepted/Delivered events `storage.key` field). Note: Storage keys are available for the duration of your domain's message retention policy.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/post-v3-domains--domain-name--messages--storage-key-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/messages/{storage_key}"},"summary":"Resend an email","description":"Resend an email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"to":{"type":"string","description":"Email address of the recipient(s). Supports friendly name format. Example: `\"Bob <bob@host.com>\"`. Use commas to separate multiple recipients. Duplicate addresses are automatically ignored.","required":true}}},"example":{"to":""}}}}}},"/v4/domains":{"get":{"tags":["Domains"],"parameters":[{"name":"limit","in":"query","description":"Max count of items. Max: 1000. Default: 100","required":false,"schema":{"type":"integer","example":""}},{"name":"skip","in":"query","description":"Get the list of items starting at the nth element. Default: 0","required":false,"schema":{"type":"integer","example":""}},{"name":"state","in":"query","description":"Get only domains with a specific state. Can be either active, unverified or disabled.","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Valid sort options are `name` which defaults to asc order, `name:asc`, or `name:desc`. If sorting is not specified domains are returned in reverse creation date order.","required":false,"schema":{"type":"string","example":""}},{"name":"authority","in":"query","description":"Get only domains with a specific authority. If state is specified then only state filtering will be proceed","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search domains by the given partial or complete name. Does not support wildcards","required":false,"schema":{"type":"string","example":""}},{"name":"include_subaccounts","in":"query","description":"Search on every domain that belongs to any subaccounts under this account. Default to false.","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains.md","api_endpoint":"https://api.mailgun.net/v4/domains"},"summary":"Get domains","description":"Get domains","security":[{"bearerAuth":[]}]},"post":{"tags":["Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/post-v4-domains.md","api_endpoint":"https://api.mailgun.net/v4/domains"},"summary":"Create a domain","description":"Create a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_to":{"type":"string","description":"If set to a URL, then each successfully delivered message will be submitted in an HTTP POST request to the URL. The Content-Type of the POST requests is application/mime and the request body is exactly what the recipient SMTP server received."},"dkim_host_name":{"type":"string","description":"Set the DKIM host name for the domain that is being created. Note, the value must be a valid domain name, and can be the domain name being created or the root domain. This parameter cannot be used in conjunction with force_dkim_authority or force_root_dkim_host."},"dkim_key_size":{"type":"string","description":"The size of the new domain's DKIM key. Shall be either 1024 or 2048."},"dkim_selector":{"type":"string","description":"Explicitly set the value of the DKIM selector for the domain being created. If the domain key does not already exist, one will be created.  The selector must be a valid atom per RFC2822. e.g valid value `foobar`, invalid value `foo.bar`  https://datatracker.ietf.org/doc/html/rfc2822#section-3.2.4"},"encrypt_incoming_message":{"type":"boolean","description":"Enable encrypting incoming messages for the given domain. This cannot be altered via API after being set for security purposes. Reach out to Support to disable if necessary. Default to false"},"force_dkim_authority":{"type":"boolean","description":"If set to true, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account. If set to false, the domain will have the same DKIM authority as the root domain registered on the same mailgun account. Default to false."},"force_root_dkim_host":{"type":"boolean","description":"If set to true, the root domain will be the DKIM Host for the domain being created even if the root domain itself is not registered with Mailgun. The domain being created will still need to pass domain verification with valid spf records for the domain and valid DKIM record for the root domain.  This does not effect the smtp mail-from host for the domain being created. The mail-from host will remain the domain name being created, not the root domain."},"wildcard":{"type":"boolean","description":"Allows domain to accept inbound messages received on subdomains that have MX records pointed to Mailgun. Default is false."},"name":{"type":"string","description":"The name of the new domain","required":true},"pool_id":{"type":"string","description":"Requested IP Pool to be assigned to the domain at creation."},"ips":{"type":"string","description":"An optional, comma-separated list of IP addresses to be assigned to this domain. If not specified, all dedicated IP addresses on the account will be assigned. If the request cannot be fulfilled (e.g. a requested IP is not assigned to the account, etc), a 400 will be returned."},"require_tls":{"type":"boolean","description":"If set to true, this requires messages for the domain only be sent over a TLS connection. If a TLS connection cannot be established, Mailgun will not deliver the message.  If set to false, Mailgun will still try and upgrade the connection, but if Mailgun cannot, the message will be delivered over a plaintext SMTP connection.  The default value is false."},"skip_verification":{"type":"boolean","description":"If set to true, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery of a message.  If set to false, Mailgun will verify the certificate and hostname. If either one can not be verified, a TLS connection will not be established.  The default value is false."},"spam_action":{"type":"string","description":"Disabled, block or tag. Default to disabled. If disabled, no spam filtering will occur for inbound messages.  If block, inbound spam messages will not be delivered.  If tag, inbound messages will be tagged with a spam header. See Spam Filter."},"smtp_password":{"type":"string","description":"Password for SMTP authentication"},"use_automatic_sender_security":{"type":"boolean","description":"Enable Automatic Sender Security. This requires setting DNS CNAME entries for DKIM keys instead of a TXT record. Defaults to false."},"web_prefix":{"type":"string","description":"Sets your open, click and unsubscribe URLs domain name prefix. Links rewritten or added by Mailgun in your emails will look like <web_scheme>://<web_prefix>.<domain_name>/... Default to email"},"web_scheme":{"type":"string","description":"Sets your open, click and unsubscribe URLs to use http or https. Value either `http` or `https`. Defaults to http. In order for https to work, you must have a valid cert created for your domain. See Domain Tracking for TLS cert generation."},"message_ttl":{"type":"integer","description":"Specifies the time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. The maximum TTL value is determined by your subscription plan."}}},"example":{"archive_to":"","dkim_host_name":"","dkim_key_size":"","dkim_selector":"","encrypt_incoming_message":"","force_dkim_authority":"","force_root_dkim_host":"","wildcard":"","name":"","pool_id":"","ips":"","require_tls":"","skip_verification":"","spam_action":"","smtp_password":"","use_automatic_sender_security":"","web_prefix":"","web_scheme":"","message_ttl":""}}}}}},"/v4/domains/{name}":{"get":{"tags":["Domains"],"parameters":[{"name":"name","in":"path","description":"The name of the domain you want to fetch","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains--name-.md","api_endpoint":"https://api.mailgun.net/v4/domains/{name}"},"summary":"Get domain details","description":"Get domain details","security":[{"bearerAuth":[]}]},"put":{"tags":["Domains"],"parameters":[{"name":"name","in":"path","description":"The name of the domain you want to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name-.md","api_endpoint":"https://api.mailgun.net/v4/domains/{name}"},"summary":"Update domain","description":"Update domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_to":{"type":"string","description":"If set to a URL, then each successfully delivered message will be submitted in an HTTP POST request to the URL. The Content-Type of the POST requests is application/mime and the request body is exactly what the recipient SMTP server received."},"mailfrom_host":{"type":"string","description":"The hostname to update to. Must be in lower case"},"message_ttl":{"type":"integer","description":"Specifies the time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. The maximum TTL value is determined by your subscription plan."},"require_tls":{"type":"boolean","description":"If set to true, this requires messages for the domain only be sent over a TLS connection. If a TLS connection cannot be established, Mailgun will not deliver the message.  If set to false, Mailgun will still try and upgrade the connection, but if Mailgun cannot, the message will be delivered over a plaintext SMTP connection.  The default value is false."},"skip_verification":{"type":"boolean","description":"If set to true, the certificate and hostname will not be verified when trying to establish a TLS connection and Mailgun will accept any certificate during delivery of a message.  If set to false, Mailgun will verify the certificate and hostname. If either one can not be verified, a TLS connection will not be established.  The default value is false."},"smtp_password":{"type":"string","description":"Updates the domain's SMTP credentials with the given string"},"spam_action":{"type":"string","description":"Updates the domain's spam action. Valid values are 'disabled', 'tag', and 'block'"},"use_automatic_sender_security":{"type":"boolean","description":"Enable or disable Automatic Sender Security. If enabled, requires setting DNS CNAME entries for DKIM keys instead of a TXT record. Domain must be reverified after changing this field. Defaults to false"},"web_scheme":{"type":"string","description":"Updates your open, click and unsubscribe URLs to use http or https. Value either `http` or `https`. Defaults to http. In order for https to work, you must have a valid cert created for your domain. See Domain Tracking for TLS cert generation."},"web_prefix":{"type":"string","description":"This updates the web prefix used for a domain's tracking features.  Must be a valid atom. Nothing will be updated if omitted. This impacts click, open, and unsubscribe tracking features.    Note: Updating the web prefix for a domain will require also updating the domain's DNS to include the CNAME record to match. For example, if you set the web prefix to `zed` for the domain `my-domain.com`, the corresponding CNAME `zed.my-domain.com` will need to be created in your domain's dns zone."},"wildcard":{"type":"boolean","description":"Updates the domain's wildcard status with the given boolean"}}},"example":{"archive_to":"","mailfrom_host":"","message_ttl":"","require_tls":"","skip_verification":"","smtp_password":"","spam_action":"","use_automatic_sender_security":"","web_scheme":"","web_prefix":"","wildcard":""}}}}}},"/v4/domains/{name}/verify":{"put":{"tags":["Domains"],"parameters":[{"name":"name","in":"path","description":"The name of the domain you want to verify","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name--verify.md","api_endpoint":"https://api.mailgun.net/v4/domains/{name}/verify"},"summary":"Verify Domain","description":"Verify Domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{name}":{"delete":{"tags":["Domains"],"parameters":[{"name":"name","in":"path","description":"The name of the domain to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/delete-v3-domains--name-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}"},"summary":"Delete a domain","description":"Delete a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{domain}/webhooks":{"get":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain","in":"path","description":"Domain name you want webhooks for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/get-v3-domains--domain--webhooks.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain}/webhooks"},"summary":"Get domain webhooks","description":"Get domain webhooks","security":[{"bearerAuth":[]}]},"post":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain","in":"path","description":"The domain name to create the webhook for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/post-v3-domains--domain--webhooks.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain}/webhooks"},"summary":"Create a domain webhook","description":"Create a domain webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"Webhook type to create.","required":true},"url":{"type":"string","description":"url(s) for webhooks to be sent to. Use multiple times to associate more than one url. Maximum of 3 urls for a given webhook type.","required":true}}},"example":{"id":"","url":""}}}}}},"/v3/domains/{domain_name}/webhooks/{webhook_name}":{"get":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name you want webhooks for","required":true,"schema":{"type":"string","example":""}},{"name":"webhook_name","in":"path","description":"The webhook type you wish to retrieve.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/get-v3-domains--domain-name--webhooks--webhook-name-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/webhooks/{webhook_name}"},"summary":"Get domain webhooks by type","description":"Get domain webhooks by type","security":[{"bearerAuth":[]}]},"put":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain you want to get webhook from","required":true,"schema":{"type":"string","example":""}},{"name":"webhook_name","in":"path","description":"The webhook type to update.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/put-v3-domains--domain-name--webhooks--webhook-name-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/webhooks/{webhook_name}"},"summary":"Update domain webhook","description":"Update domain webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"New url(s) to associate to webhook. Use multiple times to associate more than one url. Maximum of 3 urls for a given type.","required":true}}},"example":{"url":""}}}}},"delete":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain_name","in":"path","description":"The domain name you want to delete the webhook(s) for","required":true,"schema":{"type":"string","example":""}},{"name":"webhook_name","in":"path","description":"The name of the webhook to delete.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/delete-v3-domains--domain-name--webhooks--webhook-name-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/webhooks/{webhook_name}"},"summary":"Delete domain webhooks by type","description":"Delete domain webhooks by type","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{domain}/webhooks":{"put":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain","in":"path","description":"The domain name to update webhooks for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/put-v4-domains--domain--webhooks.md","api_endpoint":"https://api.mailgun.net/v4/domains/{domain}/webhooks"},"summary":"Update domain webhooks (v4)","description":"Update domain webhooks (v4)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain","in":"path","description":"The domain name to create webhooks for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/post-v4-domains--domain--webhooks.md","api_endpoint":"https://api.mailgun.net/v4/domains/{domain}/webhooks"},"summary":"Create domain webhooks (v4)","description":"Create domain webhooks (v4)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Domain Webhooks"],"parameters":[{"name":"domain","in":"path","description":"The domain name to delete webhooks from","required":true,"schema":{"type":"string","example":""}},{"name":"url","in":"query","description":"The webhook URL(s) to delete. Supports comma-separated URLs to delete multiple at once (e.g., `url1,url2,url3`). Each URL will be removed from all event types.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-webhooks/delete-v4-domains--domain--webhooks.md","api_endpoint":"https://api.mailgun.net/v4/domains/{domain}/webhooks"},"summary":"Delete domain webhooks (v4)","description":"Delete domain webhooks (v4)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{name}/tracking":{"get":{"tags":["Domain Tracking"],"parameters":[{"name":"name","in":"path","description":"The name of the domain to fetch tracking details for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v3-domains--name--tracking.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/tracking"},"summary":"Get tracking settings","description":"Get tracking settings","security":[{"bearerAuth":[]}]}},"/v3/domains/{name}/tracking/click":{"put":{"tags":["Domain Tracking"],"parameters":[{"name":"name","in":"path","description":"The name of the domain you want to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-click.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/tracking/click"},"summary":"Update click tracking settings","description":"Update click tracking settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"string","description":"Set param to `htmlonly`, `true`, or `false`.  Omit this param to make no change to the active status. Click tracking is consider as active if it's in the 'htmlonly' or 'true' state"}}},"example":{"active":""}}}}}},"/v3/domains/{name}/tracking/open":{"put":{"tags":["Domain Tracking"],"parameters":[{"name":"name","in":"path","description":"The name of the domain you want to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-open.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/tracking/open"},"summary":"Update open tracking settings","description":"Update open tracking settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Set this param to true or false to toggle open tracking active status. Omit this param to keep current settings."},"place_at_the_top":{"type":"boolean","description":"Setting this param to true will place the open tracking pixel at the top of the HTML body when inserted into the email mime. Omit this param to keep current setting."}}},"example":{"active":"","place_at_the_top":""}}}}}},"/v3/domains/{name}/tracking/unsubscribe":{"put":{"tags":["Domain Tracking"],"parameters":[{"name":"name","in":"path","description":"The name of the domain you want to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-unsubscribe.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/tracking/unsubscribe"},"summary":"Update unsubscribe tracking settings","description":"Update unsubscribe tracking settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"This param will toggle the active status of unsubscribe tracking on the domain."},"html_footer":{"type":"string","description":"Updates the html footer for the unsubscribe link inserted into the email html part of the mime."},"text_footer":{"type":"string","description":"Updates the text footer for the unsubscribe link inserted into the email plain part of the mime."}}},"example":{"active":"","html_footer":"","text_footer":""}}}}}},"/v1/dkim/keys":{"get":{"tags":["Domain Keys"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v1-dkim-keys.md","api_endpoint":"https://api.mailgun.net/v1/dkim/keys"},"summary":"List keys for all domains","description":"List keys for all domains","security":[{"bearerAuth":[]}]},"post":{"tags":["Domain Keys"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/post-v1-dkim-keys.md","api_endpoint":"https://api.mailgun.net/v1/dkim/keys"},"summary":"Create a domain key","description":"Create a domain key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"signing_domain":{"type":"string","description":"Signing domain to be used for the new domain key","required":true},"selector":{"type":"string","description":"Selector to be used for the new domain key","required":true},"bits":{"type":"integer","description":"Key size, can be 1024 or 2048"},"pem":{"type":"string","description":"Private key PEM file"}}},"example":{"signing_domain":"","selector":"","bits":"","pem":""}}}}},"delete":{"tags":["Domain Keys"],"parameters":[{"name":"signing_domain","in":"query","description":"Signing Domain","required":true,"schema":{"type":"string","example":""}},{"name":"selector","in":"query","description":"Selector","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/delete-v1-dkim-keys.md","api_endpoint":"https://api.mailgun.net/v1/dkim/keys"},"summary":"Delete a domain key","description":"Delete a domain key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{authority_name}/keys/{selector}/activate":{"put":{"tags":["Domain Keys"],"parameters":[{"name":"authority_name","in":"path","description":"The domain authority name you want to activate. Must be a valid domain","required":true,"schema":{"type":"string","example":""}},{"name":"selector","in":"path","description":"The selector you want to activate for the domain key. Must be a valid dot atom","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--activate.md","api_endpoint":"https://api.mailgun.net/v4/domains/{authority_name}/keys/{selector}/activate"},"summary":"Activate a domain key","description":"Activate a domain key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/domains/{authority_name}/keys":{"get":{"tags":["Domain Keys"],"parameters":[{"name":"authority_name","in":"path","description":"The domain authority name you want to list the domain keys for. Must be a valid domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v4-domains--authority-name--keys.md","api_endpoint":"https://api.mailgun.net/v4/domains/{authority_name}/keys"},"summary":"List domain keys","description":"List domain keys","security":[{"bearerAuth":[]}]}},"/v4/domains/{authority_name}/keys/{selector}/deactivate":{"put":{"tags":["Domain Keys"],"parameters":[{"name":"authority_name","in":"path","description":"The domain authority name you want to deactivate. Must be a valid domain","required":true,"schema":{"type":"string","example":""}},{"name":"selector","in":"path","description":"The selector you want to deactivate for the domain key. Must be a valid dot atom","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--deactivate.md","api_endpoint":"https://api.mailgun.net/v4/domains/{authority_name}/keys/{selector}/deactivate"},"summary":"Deactivate a domain key","description":"Deactivate a domain key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{name}/dkim_authority":{"put":{"tags":["Domain Keys"],"parameters":[{"name":"name","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-authority.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/dkim_authority"},"summary":"Update DKIM authority","description":"Update DKIM authority","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"self":{"type":"boolean","description":"Change the DKIM authority for a domain. If set to true, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account  If set to false, the domain will have the same DKIM authority as the root domain registered on the same mailgun account."}}},"example":{"self":""}}}}}},"/v3/domains/{name}/dkim_selector":{"put":{"tags":["Domain Keys"],"parameters":[{"name":"name","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-selector.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/dkim_selector"},"summary":"Update a DKIM selector","description":"Update a DKIM selector","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"dkim_selector":{"type":"string","description":"Update the DKIM selector for a domain. If omitted no change is committed."}}},"example":{"dkim_selector":""}}}}}},"/v1/webhooks":{"get":{"tags":["Account Webhooks"],"parameters":[{"name":"webhook_ids","in":"query","description":"Comma-separated list of webhook IDs to filter results. If specified, only webhooks with matching IDs will be returned.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-webhooks/get-v1-webhooks.md","api_endpoint":"https://api.mailgun.net/v1/webhooks"},"summary":"List account-level webhooks","description":"List account-level webhooks","security":[{"bearerAuth":[]}]},"post":{"tags":["Account Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-webhooks/post-v1-webhooks.md","api_endpoint":"https://api.mailgun.net/v1/webhooks"},"summary":"Create an account-level webhook","description":"Create an account-level webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description for the webhook"},"event_types":{"type":"string","description":"Event types to subscribe to. Use multiple times to specify multiple event types. Maximum of 3 unique URLs per event type.","required":true},"url":{"type":"string","description":"URL for webhook to be sent to","required":true}}},"example":{"description":"","event_types":"","url":""}}}}},"delete":{"tags":["Account Webhooks"],"parameters":[{"name":"webhook_ids","in":"query","description":"Comma-separated list of webhook IDs to delete. If provided, only these specific webhooks will be deleted.","required":false,"schema":{"type":"string","example":""}},{"name":"all","in":"query","description":"Set to 'true' to delete all account-level webhooks. This acts as a safety mechanism to prevent accidental deletion of all webhooks.","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-webhooks/delete-v1-webhooks.md","api_endpoint":"https://api.mailgun.net/v1/webhooks"},"summary":"Delete account-level webhooks","description":"Delete account-level webhooks","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/webhooks/{webhook_id}":{"get":{"tags":["Account Webhooks"],"parameters":[{"name":"webhook_id","in":"path","description":"The webhook ID to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-webhooks/get-v1-webhooks--webhook-id-.md","api_endpoint":"https://api.mailgun.net/v1/webhooks/{webhook_id}"},"summary":"Get account-level webhook by ID","description":"Get account-level webhook by ID","security":[{"bearerAuth":[]}]},"put":{"tags":["Account Webhooks"],"parameters":[{"name":"webhook_id","in":"path","description":"The webhook ID to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-webhooks/put-v1-webhooks--webhook-id-.md","api_endpoint":"https://api.mailgun.net/v1/webhooks/{webhook_id}"},"summary":"Update an account-level webhook","description":"Update an account-level webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description for the webhook"},"event_types":{"type":"string","description":"Event types to subscribe to. Use multiple times to specify multiple event types. Maximum of 3 unique URLs per event type.","required":true},"url":{"type":"string","description":"URL for webhook to be sent to","required":true}}},"example":{"description":"","event_types":"","url":""}}}}},"delete":{"tags":["Account Webhooks"],"parameters":[{"name":"webhook_id","in":"path","description":"The webhook ID to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-webhooks/delete-v1-webhooks--webhook-id-.md","api_endpoint":"https://api.mailgun.net/v1/webhooks/{webhook_id}"},"summary":"Delete account-level webhook by ID","description":"Delete account-level webhook by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{name}/sending_queues":{"get":{"tags":["Messages"],"parameters":[{"name":"name","in":"path","description":"The name of the domain you want get sending queues from","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--name--sending-queues.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/sending_queues"},"summary":"Get messages queue status","description":"Get messages queue status","security":[{"bearerAuth":[]}]}},"/v1/dkim_management/domains/{name}/rotation":{"put":{"tags":["DKIM Security"],"parameters":[{"name":"name","in":"path","description":"The Domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dkim-security/put-v1-dkim-management-domains--name--rotation.md","api_endpoint":"https://api.mailgun.net/v1/dkim_management/domains/{name}/rotation"},"summary":"Update Automatic Sender Security DKIM key rotation for a domain","description":"Update Automatic Sender Security DKIM key rotation for a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rotation_enabled":{"type":"boolean","description":"If true, enables DKIM Auto-Rotation. If false, disables it","required":true},"rotation_interval":{"type":"string","description":"The interval at which to rotate keys. Example, '5d' for five days"}}},"example":{"rotation_enabled":"","rotation_interval":""}}}}}},"/v1/dkim_management/domains/{name}/rotate":{"post":{"tags":["DKIM Security"],"parameters":[{"name":"name","in":"path","description":"The Domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dkim-security/post-v1-dkim-management-domains--name--rotate.md","api_endpoint":"https://api.mailgun.net/v1/dkim_management/domains/{name}/rotate"},"summary":"Rotate Automatic Sender Security DKIM key for a domain","description":"Rotate Automatic Sender Security DKIM key for a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/subaccounts/ip_pools/all":{"get":{"tags":["IP Pools"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/delegated-dipps/get-v5-accounts-subaccounts-ip-pools-all.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/ip_pools/all"},"summary":"List DIPPs delegated to subaccounts","description":"List DIPPs delegated to subaccounts","security":[{"bearerAuth":[]}]}},"/v5/accounts/subaccounts/{subaccountId}/ip_pool":{"put":{"tags":["Other"],"parameters":[{"name":"subaccountId","in":"path","description":"Id of the subaccount to delegate the DIPP to","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/openapi-tower_other/put-v5-accounts-subaccounts--subaccountid--ip-pool.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccountId}/ip_pool"},"summary":"Delegate a DIPP to a subaccount","description":"Delegate a DIPP to a subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Other"],"parameters":[{"name":"subaccountId","in":"path","description":"Id of the subaccount to revoke the DIPP from","required":true,"schema":{"type":"string","example":""}},{"name":"pool_id","in":"query","description":"Id of the DIPP to revoke","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/openapi-tower_other/delete-v5-accounts-subaccounts--subaccountid--ip-pool.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccountId}/ip_pool"},"summary":"Revoke a DIPP delegated to a subaccount","description":"Revoke a DIPP delegated to a subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{name}/ips/{ip}":{"delete":{"tags":["IPs"],"parameters":[{"name":"ip","in":"path","description":"One of the following: `all`, `ip_pool` or a valid IP address.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"Domain name. Converted to `X-Mailgun-Domain-Id` header by the middleware.","required":true,"schema":{"type":"string","example":""}},{"name":"pool_id","in":"query","description":"Replacement DIPP id.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-domains--name--ips--ip-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/ips/{ip}"},"summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","description":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{name}/pool/{ip}":{"delete":{"tags":["IPs"],"parameters":[{"name":"ip","in":"path","description":"One of the following: `all`, `ip_pool` or a valid IP address.","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"Domain name. Converted to `X-Mailgun-Domain-Id` header by the middleware.","required":true,"schema":{"type":"string","example":""}},{"name":"pool_id","in":"query","description":"Replacement DIPP id.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-domains--name--pool--ip-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/pool/{ip}"},"summary":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","description":"Remove an IP from the domain pool, unlink a DIPP or remove the domain pool","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{name}/dynamic_pools":{"post":{"tags":["IP Pools"],"parameters":[{"name":"name","in":"path","description":"Domain name","required":true,"schema":{"type":"string","example":""}},{"name":"replacement_ip","in":"query","description":"A valid IP address or 'shared'","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-domains--name--dynamic-pools.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/dynamic_pools"},"summary":"Enroll domain","description":"Enroll domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["IP Pools"],"parameters":[{"name":"name","in":"path","description":"Domain name","required":true,"schema":{"type":"string","example":""}},{"name":"replacement_ip","in":"query","description":"A valid IP address or 'shared'. This field can be specified multiple times if all provided IPs are dedicated. Cannot be provided if providing 'replacement_pool_id' param","required":true,"schema":{"type":"string","example":""}},{"name":"replacement_pool_id","in":"query","description":"A valid dedicated IP pool ID to assign to the domain. Cannot be provided if providing 'replacement_ip' param","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v3-domains--name--dynamic-pools.md","api_endpoint":"https://api.mailgun.net/v3/domains/{name}/dynamic_pools"},"summary":"Remove domain from dynamic IP pools","description":"Remove domain from dynamic IP pools","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/dynamic_pools/assignable":{"get":{"tags":["IP Pools"],"parameters":[{"name":"subaccount_id","in":"query","description":"If provided, queries domains belonging to the subaccount. Must be a valid account ID","required":false,"schema":{"type":"string","example":""}},{"name":"domain","in":"query","description":"Regex search term to query a domain by name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v3-domains-dynamic-pools-assignable.md","api_endpoint":"https://api.mailgun.net/v3/domains/dynamic_pools/assignable"},"summary":"List assignable domains","description":"List assignable domains","security":[{"bearerAuth":[]}]}},"/v3/domains/all/dynamic_pools/enroll":{"post":{"tags":["IP Pools"],"parameters":[{"name":"include_subaccounts","in":"query","description":"If true, domains belonging to subaccounts will also be enrolled in Dynamic IP Pools","required":true,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-domains-all-dynamic-pools-enroll.md","api_endpoint":"https://api.mailgun.net/v3/domains/all/dynamic_pools/enroll"},"summary":"Enroll all account domains","description":"Enroll all account domains","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/ips":{"get":{"tags":["IPs"],"parameters":[{"name":"dedicated","in":"query","description":"Return only dedicated IPs","required":false,"schema":{"type":"boolean","example":""}},{"name":"enabled","in":"query","description":"Return only enabled IPs","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips.md","api_endpoint":"https://api.mailgun.net/v3/ips"},"summary":"List account IPs","description":"List account IPs","security":[{"bearerAuth":[]}]}},"/v3/ips/{ip}":{"get":{"tags":["IPs"],"parameters":[{"name":"ip","in":"path","description":"IP address to get details about","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips--ip-.md","api_endpoint":"https://api.mailgun.net/v3/ips/{ip}"},"summary":"Get details about account IP","description":"Get details about account IP","security":[{"bearerAuth":[]}]}},"/v3/ips/{ip}/domains":{"get":{"tags":["IPs"],"parameters":[{"name":"ip","in":"path","description":"The IP to filter on","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The limit to apply to the returned domains","required":true,"schema":{"type":"integer","example":""}},{"name":"search","in":"query","description":"The search query that the returned domains' names must match","required":true,"schema":{"type":"string","example":""}},{"name":"skip","in":"query","description":"The number of matching domains to skip in the response","required":true,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips--ip--domains.md","api_endpoint":"https://api.mailgun.net/v3/ips/{ip}/domains"},"summary":"Get all domains of an account where a specific IP is assigned","description":"Get all domains of an account where a specific IP is assigned","security":[{"bearerAuth":[]}]},"post":{"tags":["IPs"],"parameters":[{"name":"ip","in":"path","description":"The IP to Add","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips--ip--domains.md","api_endpoint":"https://api.mailgun.net/v3/ips/{ip}/domains"},"summary":"Assign an IP to all account domains","description":"Assign an IP to all account domains","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["IPs"],"parameters":[{"name":"ip","in":"path","description":"The IP to Remove","required":true,"schema":{"type":"string","example":""}},{"name":"alternative","in":"query","description":"An IP that will replace the removed IP on all domains","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/delete-v3-ips--ip--domains.md","api_endpoint":"https://api.mailgun.net/v3/ips/{ip}/domains"},"summary":"Remove an IP from all account domains","description":"Remove an IP from all account domains","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/ips/{addr}/ip_band":{"post":{"tags":["IPs"],"parameters":[{"name":"addr","in":"path","description":"IP address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips--addr--ip-band.md","api_endpoint":"https://api.mailgun.net/v3/ips/{addr}/ip_band"},"summary":"Place account IP into a dedicated IP band","description":"Place account IP into a dedicated IP band","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ip_band":{"type":"string","description":"Dedicated IP band to place the IP address into","required":true}}},"example":{"ip_band":""}}}}}},"/v3/ips/request/new":{"get":{"tags":["IPs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-request-new.md","api_endpoint":"https://api.mailgun.net/v3/ips/request/new"},"summary":"Return the number of IPs available to the account per its billing plan","description":"Return the number of IPs available to the account per its billing plan","security":[{"bearerAuth":[]}]},"post":{"tags":["IPs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/post-v3-ips-request-new.md","api_endpoint":"https://api.mailgun.net/v3/ips/request/new"},"summary":"Add a new dedicated IP to the account","description":"Add a new dedicated IP to the account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/ips/details/all":{"get":{"tags":["IPs"],"parameters":[{"name":"limit","in":"query","description":"Maximum records to return","required":false,"schema":{"type":"integer","example":""}},{"name":"skip","in":"query","description":"The amount of returned records to skip","required":false,"schema":{"type":"integer","example":""}},{"name":"pool_id","in":"query","description":"Filter IPs linked to a pool. Value can be a specific pool ID, 'any' or 'none'","required":false,"schema":{"type":"string","example":""}},{"name":"domain_id","in":"query","description":"Filter IPs linked to a domain. Value can be a specific domain ID, 'any' or 'none'","required":false,"schema":{"type":"string","example":""}},{"name":"subaccount_id","in":"query","description":"Filter IPs linked to a subaccount. Value can be a specific subaccount ID, 'any' or 'none'","required":false,"schema":{"type":"string","example":""}},{"name":"sort_by","in":"query","description":"Name of the field to sort results by","required":false,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"Sort results 'descending' or 'ascending'","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ips/get-v3-ips-details-all.md","api_endpoint":"https://api.mailgun.net/v3/ips/details/all"},"summary":"List account IPs - detailed view","description":"List account IPs - detailed view","security":[{"bearerAuth":[]}]}},"/v3/dynamic_pools":{"get":{"tags":["IP Pools"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v3-dynamic-pools.md","api_endpoint":"https://api.mailgun.net/v3/dynamic_pools"},"summary":"List all Dynamic IP pools","description":"List all Dynamic IP pools","security":[{"bearerAuth":[]}]}},"/v3/dynamic_pools/all":{"post":{"tags":["IP Pools"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-dynamic-pools-all.md","api_endpoint":"https://api.mailgun.net/v3/dynamic_pools/all"},"summary":"Initialize/set IPs for all pools","description":"Initialize/set IPs for all pools","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"good_reputation":{"type":"string","description":"IP(s) to include in the good_reputation pool","required":true},"poor_reputation":{"type":"string","description":"IP(s) to include in the poor_reputation pool","required":true},"new_senders":{"type":"string","description":"IP(s) to include in the new_senders pool","required":true}}},"example":{"good_reputation":"","poor_reputation":"","new_senders":""}}}}},"delete":{"tags":["IP Pools"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v3-dynamic-pools-all.md","api_endpoint":"https://api.mailgun.net/v3/dynamic_pools/all"},"summary":"Remove all dynamic IP pools","description":"Remove all dynamic IP pools","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/dynamic_pools/{pool_name}/{ip}":{"post":{"tags":["IP Pools"],"parameters":[{"name":"pool_name","in":"path","description":"The name of the Dynamic IP Pool to add the IP to (ex: dynamic_good, dynamic_poor, etc.)","required":true,"schema":{"type":"string","example":""}},{"name":"ip","in":"path","description":"The ip to add to the given Dynamic IP Pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/post-v3-dynamic-pools--pool-name---ip-.md","api_endpoint":"https://api.mailgun.net/v3/dynamic_pools/{pool_name}/{ip}"},"summary":"Add IP to Dynamic IP Pool","description":"Add IP to Dynamic IP Pool","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/dynamic_pools/{pool_name}":{"patch":{"tags":["IP Pools"],"parameters":[{"name":"pool_name","in":"path","description":"The name of the dynamic IP pool","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/patch-v3-dynamic-pools--pool-name-.md","api_endpoint":"https://api.mailgun.net/v3/dynamic_pools/{pool_name}"},"summary":"Update pool IPs","description":"Update pool IPs","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"add_ip":{"type":"string","description":"IP(s) to add to the pool","required":true},"remove_ip":{"type":"string","description":"IP(s) to remove from the pool","required":true}}},"example":{"add_ip":"","remove_ip":""}}}}}},"/v3/ip_pools":{"get":{"tags":["IP Pools"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools"},"summary":"List dedicated IP pools of the account","description":"List dedicated IP pools of the account","security":[{"bearerAuth":[]}]},"post":{"tags":["IP Pools"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/post-v3-ip-pools.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools"},"summary":"Add a new DIPP to the account","description":"Add a new DIPP to the account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description of the DIPP","required":true},"ip":{"type":"string","description":"IP address to add to the DIPP (may be specified multiple times)"},"name":{"type":"string","description":"Short name of the DIPP","required":true}}},"example":{"description":"","ip":"","name":""}}}}}},"/v3/ip_pools/{pool_id}":{"get":{"tags":["IP Pools"],"parameters":[{"name":"pool_id","in":"path","description":"Id of the DIPP to get details about","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools--pool-id-.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}"},"summary":"Get DIPP details","description":"Get DIPP details","security":[{"bearerAuth":[]}]},"delete":{"tags":["IP Pools"],"parameters":[{"name":"pool_id","in":"path","description":"Id of the DIPP to delete","required":true,"schema":{"type":"string","example":""}},{"name":"ip","in":"query","description":"Replacement IP or a special value `shared`","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id-.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}"},"summary":"Delete the DIPP","description":"Delete the DIPP","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["IP Pools"],"parameters":[{"name":"pool_id","in":"path","description":"Id of the DIPP to edit","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/patch-v3-ip-pools--pool-id-.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}"},"summary":"Edit DIPP","description":"Edit DIPP","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"add_ip":{"type":"string","description":"The IP to add to the DIPP (may be specified multiple times)"},"description":{"type":"string","description":"The new description for the DIPP"},"link_domain":{"type":"string","description":"The ID of the domain link to the DIPP (may be specified multiple times)"},"name":{"type":"string","description":"The new short for the DIPP"},"remove_ip":{"type":"string","description":"The IP to remove from the DIPP (may be specified multiple times)"},"unlink_domain":{"type":"string","description":"The ID of the domain to unlink from the DIPP (may be specified multiple times)"}}},"example":{"add_ip":"","description":"","link_domain":"","name":"","remove_ip":"","unlink_domain":""}}}}}},"/v3/ip_pools/{pool_id}/domains":{"get":{"tags":["IP Pools"],"parameters":[{"name":"pool_id","in":"path","description":"Id of the DIPP to get details about","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of records to return","required":false,"schema":{"type":"integer","example":""}},{"name":"page","in":"query","description":"Encoded page identifier retrieved from previous call","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/get-v3-ip-pools--pool-id--domains.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}/domains"},"summary":"Get domains linked to DIPP","description":"Get domains linked to DIPP","security":[{"bearerAuth":[]}]}},"/v3/ip_pools/{pool_id}/ips/{ip}":{"put":{"tags":["IP Pools"],"parameters":[{"name":"ip","in":"path","description":"IP to add to the DIPP","required":true,"schema":{"type":"string","example":""}},{"name":"pool_id","in":"path","description":"Id of the DIPP to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/put-v3-ip-pools--pool-id--ips--ip-.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}/ips/{ip}"},"summary":"Add an IP to a DIPP","description":"Add an IP to a DIPP","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["IP Pools"],"parameters":[{"name":"ip","in":"path","description":"The IP to remove","required":true,"schema":{"type":"string","example":""}},{"name":"pool_id","in":"path","description":"The id of the DIPP","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id--ips--ip-.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}/ips/{ip}"},"summary":"Remove an IP from a DIPP","description":"Remove an IP from a DIPP","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/ip_pools/{pool_id}/ips.json":{"post":{"tags":["IP Pools"],"parameters":[{"name":"pool_id","in":"path","description":"Id of the DIPP to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/post-v3-ip-pools--pool-id--ips-json.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}/ips.json"},"summary":"Add multiple IPs to the DIPP","description":"Add multiple IPs to the DIPP","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ips":{"type":"array","description":"IPs to add to the DIPP","required":true,"items":{"type":"string"}}}},"example":{"ips":["192.168.1.1","10.0.0.1"]}}}}}},"/v3/ip_pools/{pool_id}/delegate":{"put":{"tags":["IP Pools"],"parameters":[{"name":"pool_id","in":"path","description":"The ID of the dedicated IP pool to delegate","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/put-v3-ip-pools--pool-id--delegate.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}/delegate"},"summary":"Delegate DIPP to Subaccount","description":"Delegate DIPP to Subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subaccount_id":{"type":"string","description":"The ID of the subaccount to delegate the pool to","required":true}}},"example":{"subaccount_id":""}}}}},"delete":{"tags":["IP Pools"],"parameters":[{"name":"pool_id","in":"path","description":"The ID of the dedicated IP pool to revoke","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-pools/delete-v3-ip-pools--pool-id--delegate.md","api_endpoint":"https://api.mailgun.net/v3/ip_pools/{pool_id}/delegate"},"summary":"Revoke DIPP from Subaccount","description":"Revoke DIPP from Subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/ip_warmups":{"get":{"tags":["IPs"],"parameters":[{"name":"page","in":"query","description":"The page to retrieve. If not specified, the first page is returned.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of results to return per page. Defaults to 10 if not specified.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/get-v3-ip-warmups.md","api_endpoint":"https://api.mailgun.net/v3/ip_warmups"},"summary":"Retrieves the list of in-flight IP address warmup statuses.","description":"Retrieves the list of in-flight IP address warmup statuses.","security":[{"bearerAuth":[]}]}},"/v3/ip_warmups/{addr}":{"get":{"tags":["IPs"],"parameters":[{"name":"addr","in":"path","description":"The IP address to retrieve the warmup status for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/get-v3-ip-warmups--addr-.md","api_endpoint":"https://api.mailgun.net/v3/ip_warmups/{addr}"},"summary":"Retrieves the status of an in-flight IP warmup","description":"Retrieves the status of an in-flight IP warmup","security":[{"bearerAuth":[]}]},"post":{"tags":["IPs"],"parameters":[{"name":"addr","in":"path","description":"The IP address to create the warmup plan for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/post-v3-ip-warmups--addr-.md","api_endpoint":"https://api.mailgun.net/v3/ip_warmups/{addr}"},"summary":"Creates a warmup plan for an IP Address","description":"Creates a warmup plan for an IP Address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["IPs"],"parameters":[{"name":"addr","in":"path","description":"The IP address to cancel the warmup plan for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/delete-v3-ip-warmups--addr-.md","api_endpoint":"https://api.mailgun.net/v3/ip_warmups/{addr}"},"summary":"Cancels the warmup plan for an IP address","description":"Cancels the warmup plan for an IP address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/dynamic_pools/domains":{"get":{"tags":["IP Pools"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of domains to return","required":false,"schema":{"type":"integer","example":""}},{"name":"account","in":"query","description":"Filter domains by account ID. Can be specified multiple times.","required":false,"schema":{"type":"string","example":""}},{"name":"pool","in":"query","description":"Filter domains to a specific Dynamic IP Pool. Can be specified multiple times.","required":false,"schema":{"type":"string","example":""}},{"name":"sort_by","in":"query","description":"Specify which field to use to sort domains","required":false,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"Specify which field to use to sort domains","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains.md","api_endpoint":"https://api.mailgun.net/v1/dynamic_pools/domains"},"summary":"List all domains assigned to dynamic IP pools","description":"List all domains assigned to dynamic IP pools","security":[{"bearerAuth":[]}]}},"/v1/dynamic_pools/domains/{name}/preview":{"get":{"tags":["IP Pools"],"parameters":[{"name":"name","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--preview.md","api_endpoint":"https://api.mailgun.net/v1/dynamic_pools/domains/{name}/preview"},"summary":"Preview domain assignment","description":"Preview domain assignment","security":[{"bearerAuth":[]}]}},"/v1/dynamic_pools/domains/{name}/history":{"get":{"tags":["IP Pools"],"parameters":[{"name":"name","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-domains--name--history.md","api_endpoint":"https://api.mailgun.net/v1/dynamic_pools/domains/{name}/history"},"summary":"List domain history","description":"List domain history","security":[{"bearerAuth":[]}]}},"/v1/dynamic_pools/domains/{name}/override":{"put":{"tags":["IP Pools"],"parameters":[{"name":"name","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/put-v1-dynamic-pools-domains--name--override.md","api_endpoint":"https://api.mailgun.net/v1/dynamic_pools/domains/{name}/override"},"summary":"Override domain assignment","description":"Override domain assignment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pool":{"type":"string","description":"The name of the Dynamic IP pool to override the domain with. Must be a valid pool name (ex: dynamic_good, dynamic_new, etc.)","required":true}}},"example":{"pool":""}}}}},"delete":{"tags":["IP Pools"],"parameters":[{"name":"name","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/delete-v1-dynamic-pools-domains--name--override.md","api_endpoint":"https://api.mailgun.net/v1/dynamic_pools/domains/{name}/override"},"summary":"Remove override","description":"Remove override","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/dynamic_pools/history":{"get":{"tags":["IP Pools"],"parameters":[{"name":"Limit","in":"query","description":"The maximum number of events to return","required":false,"schema":{"type":"integer","example":""}},{"name":"include_subaccounts","in":"query","description":"If true, includes events from all subaccounts in addition to events from the parent account","required":false,"schema":{"type":"boolean","example":""}},{"name":"domain","in":"query","description":"Filter events by domain name","required":false,"schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"Filter events emitted before a given timestamp (Format: Mon, 02 Jan 2006 15:04:05 MST)","required":false,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Filter events emitted after a given timestamp (Format: Mon, 02 Jan 2006 15:04:05 MST)","required":false,"schema":{"type":"string","example":""}},{"name":"moved_to","in":"query","description":"Filter events by which Dynamic Pool a domain was moved to (ex. dynamic_good, dynamic_poor, etc.)","required":false,"schema":{"type":"string","example":""}},{"name":"moved_from","in":"query","description":"Filter events by which Dynamic Pool a domain was moved from (ex. dynamic_good, dynamic_poor, etc.)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dynamic-ip-pools/get-v1-dynamic-pools-history.md","api_endpoint":"https://api.mailgun.net/v1/dynamic_pools/history"},"summary":"List account history","description":"List account history","security":[{"bearerAuth":[]}]}},"/v3/{domain_name}/envelopes":{"delete":{"tags":["Messages"],"parameters":[{"name":"domain_name","in":"path","description":"The name of the domain you want to delete envelope from","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/delete-v3--domain-name--envelopes.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/envelopes"},"summary":"Delete scheduled and undelivered mail","description":"Delete scheduled and undelivered mail","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/x509/{domain}/status":{"get":{"tags":["Domain Tracking"],"parameters":[{"name":"domain","in":"path","description":"The tracking domain of the TLS certificate, formatted as `web_prefix.domain_name` (`web_prefix` is configured in your domains settings)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v2-x509--domain--status.md","api_endpoint":"https://api.mailgun.net/v2/x509/{domain}/status"},"summary":"Tracking Certificate: Get certificate and status","description":"Tracking Certificate: Get certificate and status","security":[{"bearerAuth":[]}]}},"/v2/x509/{domain}":{"put":{"tags":["Domain Tracking"],"parameters":[{"name":"domain","in":"path","description":"The tracking domain of the TLS certificate, formatted as webPrefix.domainName from domains settings","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v2-x509--domain-.md","api_endpoint":"https://api.mailgun.net/v2/x509/{domain}"},"summary":"Tracking Certificate: Regenerate expired certificate","description":"Tracking Certificate: Regenerate expired certificate","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Domain Tracking"],"parameters":[{"name":"domain","in":"path","description":"The tracking domain of the TLS certificate, formatted as webPrefix.domainName from domains settings","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/post-v2-x509--domain-.md","api_endpoint":"https://api.mailgun.net/v2/x509/{domain}"},"summary":"Tracking Certificate: Generate","description":"Tracking Certificate: Generate","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/events":{"get":{"tags":["Events"],"parameters":[{"name":"domain_name","in":"path","description":"Filter by sending domain","required":true,"schema":{"type":"string","example":""}},{"name":"begin","in":"query","description":"The beginning of the search time range in epoch seconds","required":false,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end of the search time range in epoch seconds","required":false,"schema":{"type":"string","example":""}},{"name":"ascending","in":"query","description":"Sort direction by time. Must be provided if the range end time is not specified. Can be either yes or no","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of entries to return (300 max)","required":false,"schema":{"type":"integer","example":""}},{"name":"event","in":"query","description":"Filter by event type","required":false,"schema":{"type":"string","example":""}},{"name":"list","in":"query","description":"Filter by mailing list email address that message was originally sent to","required":false,"schema":{"type":"string","example":""}},{"name":"attachment","in":"query","description":"Filter by the name of an attached file","required":false,"schema":{"type":"string","example":""}},{"name":"from","in":"query","description":"Filter by email address mentioned in the From MIME header","required":false,"schema":{"type":"string","example":""}},{"name":"message-id","in":"query","description":"Filter by Mailgun message id returned by the messages API","required":false,"schema":{"type":"string","example":""}},{"name":"subject","in":"query","description":"Filter by subject line","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Filter by email address mentioned in the To MIME header","required":false,"schema":{"type":"string","example":""}},{"name":"size","in":"query","description":"Filter by message size. Mostly intended to be used with range filtering expressions","required":false,"schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"Filter by email address of a recipient. While messages are addressable to one or more recipients, each event (with one exception) tracks one recipient. See stored events for use of recipients","required":false,"schema":{"type":"string","example":""}},{"name":"recipients","in":"query","description":"Specific to stored events, this field tracks all of the potential message recipients.","required":false,"schema":{"type":"string","example":""}},{"name":"tags","in":"query","description":"Filter by user defined tags","required":false,"schema":{"type":"string","example":""}},{"name":"severity","in":"query","description":"Filter by event severity, if exists. Currently for failed events only. See [Tracking Failures](https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/#tracking-failures)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/events/get-v3-domain_name-events.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/events"},"summary":"Retrieves a paginated list of events","description":"Retrieves a paginated list of events","security":[{"bearerAuth":[]}]}},"/v3/{domain}/tags":{"get":{"tags":["Tags"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"The page direction based on the tag parameter; valid choices are (first, last, next, prev)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limits the number of items returned in a request","required":false,"schema":{"type":"integer","example":""}},{"name":"tag","in":"query","description":"The tag that marks the end of the current page and the start of the next","required":false,"schema":{"type":"string","example":""}},{"name":"prefix","in":"query","description":"List only tags that begin with this prefix","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tags.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/tags"},"summary":"List all tags","description":"List all tags","security":[{"bearerAuth":[]}]}},"/v3/{domain}/tag":{"get":{"tags":["Tags"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/tag"},"summary":"Get a tag","description":"Get a tag","security":[{"bearerAuth":[]}]},"put":{"tags":["Tags"],"parameters":[{"name":"domain","in":"path","description":"The domain id","required":true,"schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}},{"name":"description","in":"query","description":"The description of the tag","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/put-v3--domain--tag.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/tag"},"summary":"Update tag ","description":"Update tag ","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Tags"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"The name of the tag","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/delete-v3--domain--tag.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/tag"},"summary":"Delete tag","description":"Delete tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain}/tag/stats/aggregates":{"get":{"tags":["Tags"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The type of aggregate (country, device, provider)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag-stats-aggregates.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/tag/stats/aggregates"},"summary":"Get aggregate stat types by tag","description":"Get aggregate stat types by tag","security":[{"bearerAuth":[]}]}},"/v3/{domain}/tag/stats":{"get":{"tags":["Tags"],"parameters":[{"name":"domain","in":"path","description":"The domain id","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)","required":false,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date in RFC 2822 format or unix epoch (default: current time)","required":false,"schema":{"type":"string","example":""}},{"name":"resolution","in":"query","description":"The gregorian resolution the query is for 'day, month, hour` (default: day)","required":false,"schema":{"type":"string","example":""}},{"name":"duration","in":"query","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date","required":false,"schema":{"type":"string","example":""}},{"name":"provider","in":"query","description":"The provider value; see `GET /v3/domains/1/tag/providers` for possible values","required":false,"schema":{"type":"string","example":""}},{"name":"device","in":"query","description":"The device value; see `GET /v3/domains/1/tag/devices` for possible values","required":false,"schema":{"type":"string","example":""}},{"name":"country","in":"query","description":"The country value; see `GET /v3/domains/1/tag/providers` for possible values","required":false,"schema":{"type":"string","example":""}},{"name":"event","in":"query","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true,"schema":{"type":"string","example":""}},{"name":"tag","in":"query","description":"The name of the tag","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag-stats.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/tag/stats"},"summary":"Get stats by tag","description":"Get stats by tag","security":[{"bearerAuth":[]}]}},"/v3/domains/{domain}/tag/devices":{"get":{"tags":["Other"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/openapi-scout_other/get-v3-domains--domain--tag-devices.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain}/tag/devices"},"summary":"List of supported devices","description":"List of supported devices","security":[{"bearerAuth":[]}]}},"/v3/domains/{domain}/tag/providers":{"get":{"tags":["Other"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/openapi-scout_other/get-v3-domains--domain--tag-providers.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain}/tag/providers"},"summary":"List of supported providers","description":"List of supported providers","security":[{"bearerAuth":[]}]}},"/v3/domains/{domain}/tag/countries":{"get":{"tags":["Other"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/openapi-scout_other/get-v3-domains--domain--tag-countries.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain}/tag/countries"},"summary":"List of supported country codes","description":"List of supported country codes","security":[{"bearerAuth":[]}]}},"/v3/stats/total":{"get":{"tags":["Stats"],"parameters":[{"name":"start","in":"query","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)","required":false,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date in RFC 2822 format or unix epoch (default: current time)","required":false,"schema":{"type":"string","example":""}},{"name":"resolution","in":"query","description":"The gregorian resolution the query is for 'day, month, hour` (default: day)","required":false,"schema":{"type":"string","example":""}},{"name":"duration","in":"query","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date","required":false,"schema":{"type":"string","example":""}},{"name":"event","in":"query","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-total.md","api_endpoint":"https://api.mailgun.net/v3/stats/total"},"summary":"Totals for entire account","description":"Totals for entire account","security":[{"bearerAuth":[]}]}},"/v3/{domain}/stats/total":{"get":{"tags":["Stats"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)","required":false,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date in RFC 2822 format or unix epoch (default: current time)","required":false,"schema":{"type":"string","example":""}},{"name":"resolution","in":"query","description":"The gregorian resolution the query is for 'day, month, hour` (default: day)","required":false,"schema":{"type":"string","example":""}},{"name":"duration","in":"query","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date","required":false,"schema":{"type":"string","example":""}},{"name":"event","in":"query","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--stats-total.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/stats/total"},"summary":"Totals for entire domain","description":"Totals for entire domain","security":[{"bearerAuth":[]}]}},"/v3/stats/total/domains":{"get":{"tags":["Stats"],"parameters":[{"name":"event","in":"query","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Skip x number of domains; used to page through large numbers of domains","required":false,"schema":{"type":"string","example":""}},{"name":"resolution","in":"query","description":"The gregorian resolution the query is for 'day, month, hour` (default: day)","required":false,"schema":{"type":"string","example":""}},{"name":"timestamp","in":"query","description":"The date/time of the 'resolution' we are retrieving","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-total-domains.md","api_endpoint":"https://api.mailgun.net/v3/stats/total/domains"},"summary":"Totals for account domains for a single time resolution","description":"Totals for account domains for a single time resolution","security":[{"bearerAuth":[]}]}},"/v3/stats/filter":{"get":{"tags":["Stats"],"parameters":[{"name":"start","in":"query","description":"The start date in RFC 2822 format or unix epoch (default: 7 days ago)","required":false,"schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date in RFC 2822 format or unix epoch (default: current time)","required":false,"schema":{"type":"string","example":""}},{"name":"resolution","in":"query","description":"The gregorian resolution the query is for 'day, month, hour` (default: day)","required":false,"schema":{"type":"string","example":""}},{"name":"duration","in":"query","description":"If duration is provided than it's calculated from the 'end' date and overwrites the 'start' date","required":false,"schema":{"type":"string","example":""}},{"name":"event","in":"query","description":"Name of the event(s) to receive the stats for (Multiple events are allowed). Supported events are: accepted, delivered, failed, opened, clicked, unsubscribed, complained, stored","required":true,"schema":{"type":"string","example":""}},{"name":"filter","in":"query","description":"A filter for account level metrics such as filter=domain:my.example.com","required":false,"schema":{"type":"string","example":""}},{"name":"group","in":"query","description":"The key to group metrics by.  Must be one of total, time, day, month, domain, ip, provider, tag, country","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-filter.md","api_endpoint":"https://api.mailgun.net/v3/stats/filter"},"summary":"Filtered/grouped totals for entire account","description":"Filtered/grouped totals for entire account","security":[{"bearerAuth":[]}]}},"/v3/domains/{domain}/limits/tag":{"get":{"tags":["Tags"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/get-v3-domains--domain--limits-tag.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain}/limits/tag"},"summary":"Get tag limits","description":"Get tag limits","security":[{"bearerAuth":[]}]}},"/v3/{domain}/aggregates/providers":{"get":{"tags":["Stats"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-providers.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/aggregates/providers"},"summary":"Aggregate counts by ESP","description":"Aggregate counts by ESP","security":[{"bearerAuth":[]}]}},"/v3/{domain}/aggregates/devices":{"get":{"tags":["Stats"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-devices.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/aggregates/devices"},"summary":"Aggregate counts by devices triggering events ","description":"Aggregate counts by devices triggering events ","security":[{"bearerAuth":[]}]}},"/v3/{domain}/aggregates/countries":{"get":{"tags":["Stats"],"parameters":[{"name":"domain","in":"path","description":"The domain name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3--domain--aggregates-countries.md","api_endpoint":"https://api.mailgun.net/v3/{domain}/aggregates/countries"},"summary":"Aggregate counts by country","description":"Aggregate counts by country","security":[{"bearerAuth":[]}]}},"/v1/analytics/metrics":{"post":{"tags":["Metrics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-metrics.md","api_endpoint":"https://api.mailgun.net/v1/analytics/metrics"},"summary":"Query account metrics","description":"Query account metrics","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"string","description":"A start date (default: 7 days before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"end":{"type":"string","description":"An end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"resolution":{"type":"string","description":"A resolution in the format of 'day' 'hour' 'month'. Default is day."},"duration":{"type":"string","description":"A duration in the format of '1d' '2h' '2m'. If duration is provided then it is calculated from the end date and overwrites the start date."},"dimensions":{"type":"array","description":"Attributes of the metric data such as 'subaccount'.  See [dimensions](https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/dimensions)","items":{"type":"string"}},"metrics":{"type":"array","description":"Name of the metrics to receive the stats for such as 'processed_count'. See [metrics](https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/metric-definitions)","items":{"type":"string"}},"filter":{"type":"object","description":"Filters to apply to the query.","properties":{"AND":{"type":"array","description":"Array of filter conditions combined with AND logic. OR is not supported."}}},"include_subaccounts":{"type":"boolean","description":"Include stats from all subaccounts."},"include_aggregates":{"type":"boolean","description":"Include top-level aggregate metrics."}}},"example":{"start":"","end":"","resolution":"","duration":"","dimensions":["subaccount","domain","country"],"metrics":["processed_count","delivered_count","failed_count"],"filter":{},"include_subaccounts":"","include_aggregates":""}}}}}},"/v1/analytics/usage/metrics":{"post":{"tags":["Metrics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-usage-metrics.md","api_endpoint":"https://api.mailgun.net/v1/analytics/usage/metrics"},"summary":"Query account usage metrics","description":"Query account usage metrics","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"string","description":"A start date (default: 7 days before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"end":{"type":"string","description":"An end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"resolution":{"type":"string","description":"A resolution in the format of 'day' 'hour' 'month'. Default is day."},"duration":{"type":"string","description":"A duration in the format of '1d' '2h' '2m'. If duration is provided then it is calculated from the end date and overwrites the start date."},"dimensions":{"type":"array","description":"Attributes of the metric data such as 'subaccount'.  See [dimensions](https://documentation.mailgun.com/docs/mailgun/user-manual/reporting/dimensions)","items":{"type":"string"}},"metrics":{"type":"array","description":"Name of the metrics to receive the stats for such as 'processed_count'.","items":{"type":"string"}},"filter":{"type":"object","description":"Filters to apply to the query.","properties":{"AND":{"type":"array","description":"Array of filter conditions combined with AND logic. OR is not supported."}}},"include_subaccounts":{"type":"boolean","description":"Include stats from all subaccounts."},"include_aggregates":{"type":"boolean","description":"Include top-level aggregate metrics."}}},"example":{"start":"","end":"","resolution":"","duration":"","dimensions":["subaccount","domain"],"metrics":["email_validation_count","email_preview_count"],"filter":{},"include_subaccounts":"","include_aggregates":""}}}}}},"/v1/analytics/logs":{"post":{"tags":["Logs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/logs/post-v1-analytics-logs.md","api_endpoint":"https://api.mailgun.net/v1/analytics/logs"},"summary":"List logs","description":"List logs","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"string","description":"The start date (default: 1 day before current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"end":{"type":"string","description":"The end date (default: current time). Must be in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14"},"duration":{"type":"string","description":"A duration in the format of '1d' '2h'. If duration is provided then it is calculated from the end date and overwrites the start date.","required":true},"events":{"type":"array","description":"The set of events to include.","items":{"type":"string"}},"metric_events":{"type":"array","description":"Optional set of analytics metric events. Will be converted into corresponding events.","items":{"type":"string"}},"filter":{"type":"object","description":"Filters to apply to the query.","properties":{"AND":{"type":"array","description":"Array of filter conditions combined with AND logic."}}},"include_subaccounts":{"type":"boolean","description":"Include logs from all subaccounts."},"include_totals":{"type":"boolean","description":"Include total number of log entries."},"pagination":{"type":"object","description":"pagination","properties":{"skip":{"type":"integer","description":"Number of items to skip from the beginning of the result set."},"limit":{"type":"integer","description":"Maximum number of items to return per page."}}}}},"example":{"start":"","end":"","duration":"","events":["accepted","delivered","failed"],"metric_events":["clicked","opened"],"filter":{},"include_subaccounts":"","include_totals":"","pagination":{}}}}}}},"/v1/analytics/tags":{"put":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/put-v1-analytics-tags.md","api_endpoint":"https://api.mailgun.net/v1/analytics/tags"},"summary":"Update account tag","description":"Update account tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"tag":{"type":"string","description":"The tag to update."},"description":{"type":"string","description":"The updated tag description."}}},"example":{"tag":"","description":""}}}}},"post":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/post-v1-analytics-tags.md","api_endpoint":"https://api.mailgun.net/v1/analytics/tags"},"summary":"Post query to list account tags or search for single tag","description":"Post query to list account tags or search for single tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pagination":{"type":"object","description":"pagination","properties":{"skip":{"type":"integer","description":"Number of items to skip from the beginning of the result set."},"limit":{"type":"integer","description":"Maximum number of items to return per page."}}},"include_subaccounts":{"type":"boolean","description":"Boolean indicating whether or not to include data from all subaccounts. Default false."},"include_metrics":{"type":"boolean","description":"Boolean indicating whether or not to include metrics for tags. Default false.  When true max limit is 20."},"tag":{"type":"string","description":"The tag or tag prefix."}}},"example":{"pagination":{},"include_subaccounts":"","include_metrics":"","tag":""}}}}},"delete":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/delete-v1-analytics-tags.md","api_endpoint":"https://api.mailgun.net/v1/analytics/tags"},"summary":"Delete account tag","description":"Delete account tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/analytics/tags/limits":{"get":{"tags":["Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/get-v1-analytics-tags-limits.md","api_endpoint":"https://api.mailgun.net/v1/analytics/tags/limits"},"summary":"Get account tag limit information","description":"Get account tag limit information","security":[{"bearerAuth":[]}]}},"/v1/thresholds/alerts/send":{"get":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-alerts-send.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/alerts/send"},"summary":"List send alerts","description":"List send alerts","security":[{"bearerAuth":[]}]},"post":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/send-alerts/post-v1-thresholds-alerts-send.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/alerts/send"},"summary":"Create a send alert for an account","description":"Create a send alert for an account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A user-friendly name for the alert.","required":true},"metric":{"type":"string","description":"The metric being monitored.","required":true},"comparator":{"type":"string","description":"The comparison operator.","required":true},"limit":{"type":"string","description":"The threshold limit for the alert.","required":true},"dimension":{"type":"string","description":"The dimension to apply to the metric.","required":true},"alert_channels":{"type":"array","description":"A list of alert channels to notify.","items":{"type":"object"}},"filters":{"type":"array","description":"A list of filters to apply to the alert.","items":{"type":"object"}},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."},"description":{"type":"string","description":"A description of what the alert does."}}},"example":{"name":"","metric":"","comparator":"","limit":"","dimension":"","alert_channels":[],"filters":[],"period":"","description":""}}}}}},"/v1/thresholds/alerts/send/{name}":{"get":{"tags":["Alerts"],"parameters":[{"name":"name","in":"path","description":"Threshold name that identifies this threshold","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-alerts-send--name-.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/alerts/send/{name}"},"summary":"Get a send alert","description":"Get a send alert","security":[{"bearerAuth":[]}]},"put":{"tags":["Alerts"],"parameters":[{"name":"name","in":"path","description":"Threshold name that identifies this threshold","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/send-alerts/put-v1-thresholds-alerts-send--name-.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/alerts/send/{name}"},"summary":"Update a send alert","description":"Update a send alert","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A user-friendly name for the alert.","required":true},"metric":{"type":"string","description":"The metric being monitored.","required":true},"comparator":{"type":"string","description":"The comparison operator.","required":true},"limit":{"type":"string","description":"The threshold limit for the alert.","required":true},"dimension":{"type":"string","description":"The dimension to apply to the metric.","required":true},"alert_channels":{"type":"array","description":"A list of alert channels to notify.","items":{"type":"object"}},"filters":{"type":"array","description":"A list of filters to apply to the alert.","items":{"type":"object"}},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."},"description":{"type":"string","description":"A description of what the alert does."}}},"example":{"name":"","metric":"","comparator":"","limit":"","dimension":"","alert_channels":[],"filters":[],"period":"","description":""}}}}},"delete":{"tags":["Alerts"],"parameters":[{"name":"name","in":"path","description":"Threshold name that identifies this threshold","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/send-alerts/delete-v1-thresholds-alerts-send--name-.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/alerts/send/{name}"},"summary":"Delete a send alert","description":"Delete a send alert","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/thresholds/limits":{"get":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/limits/get-v1-thresholds-limits.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/limits"},"summary":"List limit thresholds for an account","description":"List limit thresholds for an account","security":[{"bearerAuth":[]}]},"post":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/limits/post-v1-thresholds-limits.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/limits"},"summary":"Create a limit threshold for an account","description":"Create a limit threshold for an account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A user-friendly name for the limit.","required":true},"metric":{"type":"string","description":"The metric being monitored.","required":true},"comparator":{"type":"string","description":"The comparison operator.","required":true},"limit":{"type":"string","description":"The threshold limit.","required":true},"dimension":{"type":"string","description":"The dimension to apply to the metric.","required":true},"filters":{"type":"array","description":"A list of filters to apply to the limit.","items":{"type":"object"}},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."},"description":{"type":"string","description":"A description of what the limit does."}}},"example":{"name":"","metric":"","comparator":"","limit":"","dimension":"","filters":[],"period":"","description":""}}}}}},"/v1/thresholds/limits/{name}":{"get":{"tags":["Account Management"],"parameters":[{"name":"name","in":"path","description":"Threshold name that identifies this threshold","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/limits/get-v1-thresholds-limits--name-.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/limits/{name}"},"summary":"Get a limit threshold for an account","description":"Get a limit threshold for an account","security":[{"bearerAuth":[]}]},"put":{"tags":["Account Management"],"parameters":[{"name":"name","in":"path","description":"Threshold name that identifies this threshold","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/limits/put-v1-thresholds-limits--name-.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/limits/{name}"},"summary":"Update a limit threshold for an account","description":"Update a limit threshold for an account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"A user-friendly name for the limit.","required":true},"metric":{"type":"string","description":"The metric being monitored.","required":true},"comparator":{"type":"string","description":"The comparison operator.","required":true},"limit":{"type":"string","description":"The threshold limit.","required":true},"dimension":{"type":"string","description":"The dimension to apply to the metric.","required":true},"filters":{"type":"array","description":"A list of filters to apply to the limit.","items":{"type":"object"}},"period":{"type":"string","description":"The time period for the metric aggregation in the format of '1h' '1d'."},"description":{"type":"string","description":"A description of what the limit does."}}},"example":{"name":"","metric":"","comparator":"","limit":"","dimension":"","filters":[],"period":"","description":""}}}}},"delete":{"tags":["Account Management"],"parameters":[{"name":"name","in":"path","description":"Threshold name that identifies this threshold","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/limits/delete-v1-thresholds-limits--name-.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/limits/{name}"},"summary":"Delete a limit threshold for an account","description":"Delete a limit threshold for an account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/thresholds/hits":{"get":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-hits.md","api_endpoint":"https://api.mailgun.net/v1/thresholds/hits"},"summary":"List account hits","description":"List account hits","security":[{"bearerAuth":[]}]}},"/v1/alerts/events":{"get":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-events.md","api_endpoint":"https://api.mailgun.net/v1/alerts/events"},"summary":"List events","description":"List events","security":[{"bearerAuth":[]}]}},"/v1/alerts/settings/events":{"post":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-settings-events.md","api_endpoint":"https://api.mailgun.net/v1/alerts/settings/events"},"summary":"Add Alert","description":"Add Alert","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"event_type":{"type":"string","description":"The type of event for which you would like to receive alerts.","required":true},"channel":{"type":"string","description":"The delivery method for the alert.","required":true},"settings":{"type":"object","description":"The details pertaining to the specified channel. Please note that the contents of this object differ per channel type.","required":true,"properties":{"email":{"type":"string","description":"Email address for email alert channel."},"slack":{"type":"string","description":"Slack webhook URL for Slack alert channel."},"webhook":{"type":"string","description":"Webhook URL for webhook alert channel."}}}}},"example":{"event_type":"","channel":"","settings":{}}}}}}},"/v1/alerts/settings/events/{id}":{"put":{"tags":["Alerts"],"parameters":[{"name":"id","in":"path","description":"The settings ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-events--id-.md","api_endpoint":"https://api.mailgun.net/v1/alerts/settings/events/{id}"},"summary":"Update Alert","description":"Update Alert","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"event_type":{"type":"string","description":"The type of event for which you would like to receive alerts.","required":true},"channel":{"type":"string","description":"The delivery method for the alert.","required":true},"settings":{"type":"object","description":"The details pertaining to the specified channel. Please note that the contents of this object differ per channel type.","required":true,"properties":{"email":{"type":"string","description":"Email address for email alert channel."},"slack":{"type":"string","description":"Slack webhook URL for Slack alert channel."},"webhook":{"type":"string","description":"Webhook URL for webhook alert channel."}}}}},"example":{"event_type":"","channel":"","settings":{}}}}}},"delete":{"tags":["Alerts"],"parameters":[{"name":"id","in":"path","description":"The settings ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-settings-events--id-.md","api_endpoint":"https://api.mailgun.net/v1/alerts/settings/events/{id}"},"summary":"Remove Alert","description":"Remove Alert","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/alerts/settings":{"get":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-settings.md","api_endpoint":"https://api.mailgun.net/v1/alerts/settings"},"summary":"List Alerts","description":"List Alerts","security":[{"bearerAuth":[]}]}},"/v1/alerts/settings/slack":{"put":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-slack.md","api_endpoint":"https://api.mailgun.net/v1/alerts/settings/slack"},"summary":"Update Slack settings","description":"Update Slack settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"token":{"type":"string","description":"token","required":true},"team_id":{"type":["string","null"],"description":"team_id","required":true},"team_name":{"type":["string","null"],"description":"team_name","required":true},"scope":{"type":["string","null"],"description":"scope","required":true}}},"example":{"token":"","team_id":"","team_name":"","scope":""}}}}},"delete":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-settings-slack.md","api_endpoint":"https://api.mailgun.net/v1/alerts/settings/slack"},"summary":"Delete Slack settings","description":"Delete Slack settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/alerts/settings/webhooks/signing_key":{"put":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/put-v1-alerts-settings-webhooks-signing-key.md","api_endpoint":"https://api.mailgun.net/v1/alerts/settings/webhooks/signing_key"},"summary":"Reset Webhook Signing Key","description":"Reset Webhook Signing Key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/alerts/webhooks/test":{"post":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-webhooks-test.md","api_endpoint":"https://api.mailgun.net/v1/alerts/webhooks/test"},"summary":"Test webhook","description":"Test webhook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"event_type":{"type":"string","description":"event_type","required":true},"url":{"type":"string","description":"url","required":true}}},"example":{"event_type":"","url":""}}}}}},"/v1/alerts/email/test":{"post":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-email-test.md","api_endpoint":"https://api.mailgun.net/v1/alerts/email/test"},"summary":"Test message","description":"Test message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"event_type":{"type":"string","description":"event_type","required":true},"emails":{"type":"array","description":"emails","required":true,"items":{"type":"string"}}}},"example":{"event_type":"","emails":["test@example.com"]}}}}}},"/v1/alerts/slack/test":{"post":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/post-v1-alerts-slack-test.md","api_endpoint":"https://api.mailgun.net/v1/alerts/slack/test"},"summary":"Test message","description":"Test message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"event_type":{"type":"string","description":"event_type","required":true},"channel_ids":{"type":"array","description":"If omitted would be taken from the event settings","items":{"type":"string"}}}},"example":{"event_type":"","channel_ids":["C12345678"]}}}}}},"/v1/alerts/slack/oauth":{"delete":{"tags":["Alerts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/delete-v1-alerts-slack-oauth.md","api_endpoint":"https://api.mailgun.net/v1/alerts/slack/oauth"},"summary":"Revoke Slack access token","description":"Revoke Slack access token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/alerts/slack/channels/{id}":{"get":{"tags":["Alerts"],"parameters":[{"name":"id","in":"path","description":"The Slack channel ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-slack-channels--id-.md","api_endpoint":"https://api.mailgun.net/v1/alerts/slack/channels/{id}"},"summary":"Get Slack channel","description":"Get Slack channel","security":[{"bearerAuth":[]}]}},"/v1/alerts/slack/channels":{"get":{"tags":["Alerts"],"parameters":[{"name":"page","in":"query","description":"Encoded paging information, provided via 'next', 'first' links","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limits the number of items returned in a request","required":false,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/alerts/get-v1-alerts-slack-channels.md","api_endpoint":"https://api.mailgun.net/v1/alerts/slack/channels"},"summary":"List Slack channels","description":"List Slack channels","security":[{"bearerAuth":[]}]}},"/v3/{domain_name}/unsubscribes/import":{"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to update unsubscribes for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes-import.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/unsubscribes/import"},"summary":"Import unsubscribe list","description":"Import unsubscribe list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"CSV file","required":true}}},"example":{"file":""}}}}}},"/v3/{domain_name}/bounces/import":{"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to update bounces for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces-import.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/bounces/import"},"summary":"Import list of bounces","description":"Import list of bounces","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"CSV file","required":true}}},"example":{"file":""}}}}}},"/v3/{domain_name}/complaints/import":{"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to update complaints for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints-import.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/complaints/import"},"summary":"Import complaint list","description":"Import complaint list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"CSV file","required":true}}},"example":{"file":""}}}}}},"/v3/{domain_name}/whitelists/import":{"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to update allowlist for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist/post-v3--domainid--whitelists-import.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/whitelists/import"},"summary":"Import allowlist","description":"Import allowlist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"CSV file","required":true}}},"example":{"file":""}}}}}},"/v3/{domain_name}/bounces/{address}":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve the bounce from","required":true,"schema":{"type":"string","example":""}},{"name":"address","in":"path","description":"The address to search for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces--address-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/bounces/{address}"},"summary":"Lookup bounce record","description":"Lookup bounce record","security":[{"bearerAuth":[]}]},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete the bounce from","required":true,"schema":{"type":"string","example":""}},{"name":"address","in":"path","description":"The address to remove","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces--address-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/bounces/{address}"},"summary":"Remove bounce","description":"Remove bounce","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/bounces":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve bounces from","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of records to return (optional, default: 100, max: 1000)","required":true,"schema":{"type":"integer","example":""}},{"name":"page","in":"query","description":"Page direction relative to the above address, can be `next`, `previous` or `last`, if empty, returns the first page","required":true,"schema":{"type":"string","example":""}},{"name":"term","in":"query","description":"Filter records based on addresses that start with the specified substring.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/bounces"},"summary":"List all bounces","description":"List all bounces","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to add the bounce to","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/bounces"},"summary":"Add bounces","description":"Add bounces","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete bounces from","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/bounces"},"summary":"Clear all bounces","description":"Clear all bounces","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/unsubscribes/{address}":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve the unsubscribe from","required":true,"schema":{"type":"string","example":""}},{"name":"address","in":"path","description":"The address to search for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes--address-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/unsubscribes/{address}"},"summary":"Lookup unsubscribe record","description":"Lookup unsubscribe record","security":[{"bearerAuth":[]}]},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete the unsubscribe from","required":true,"schema":{"type":"string","example":""}},{"name":"address","in":"path","description":"The address to remove","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes--address-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/unsubscribes/{address}"},"summary":"Remove unsubscribe","description":"Remove unsubscribe","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/unsubscribes":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve unsubscribes from","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of records to return (optional, default: 100, max: 1000)","required":false,"schema":{"type":"integer","example":""}},{"name":"page","in":"query","description":"Page direction relative to the above address, can be `next`, `previous` or `last`, if empty, returns the first page","required":false,"schema":{"type":"string","example":""}},{"name":"address","in":"query","description":"address serving as a \"divider\" between pages","required":true,"schema":{"type":"string","example":""}},{"name":"term","in":"query","description":"Filter records based on addresses that start with the specified substring.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/unsubscribes"},"summary":"List all unsubscribes","description":"List all unsubscribes","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to add the unsubscribe to","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/unsubscribes"},"summary":"Add unsubscribes","description":"Add unsubscribes","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete unsubscribes from","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/unsubscribes"},"summary":"Clear all unsubscribes","description":"Clear all unsubscribes","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/complaints/{address}":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve the complaint from","required":true,"schema":{"type":"string","example":""}},{"name":"address","in":"path","description":"The address to search for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints--address-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/complaints/{address}"},"summary":"Lookup complaint record","description":"Lookup complaint record","security":[{"bearerAuth":[]}]},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete the complaint from","required":true,"schema":{"type":"string","example":""}},{"name":"address","in":"path","description":"The address to remove","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints--address-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/complaints/{address}"},"summary":"Remove complaint","description":"Remove complaint","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/complaints":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve complaints from","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of records to return (optional, default: 100, max: 1000)","required":false,"schema":{"type":"integer","example":""}},{"name":"page","in":"query","description":"Page direction relative to the above address, can be `next`, `previous` or `last`, if empty, returns the first page","required":false,"schema":{"type":"string","example":""}},{"name":"address","in":"query","description":"address serving as a \"divider\" between pages","required":true,"schema":{"type":"string","example":""}},{"name":"term","in":"query","description":"Filter records based on addresses that start with the specified substring.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/complaints"},"summary":"List all complaints","description":"List all complaints","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to add the complaint to","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/complaints"},"summary":"Add complaints","description":"Add complaints","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete complaints from","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/complaints"},"summary":"Clear all complaints","description":"Clear all complaints","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/whitelists/{value}":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve the allowlist entry from","required":true,"schema":{"type":"string","example":""}},{"name":"value","in":"path","description":"The address to search for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist/get-v3--domainid--whitelists--value-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/whitelists/{value}"},"summary":"Lookup allowlist record","description":"Lookup allowlist record","security":[{"bearerAuth":[]}]},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete the allowlist entry from","required":true,"schema":{"type":"string","example":""}},{"name":"value","in":"path","description":"The address to remove","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist/delete-v3--domainid--whitelists--value-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/whitelists/{value}"},"summary":"Remove entry from allowlist","description":"Remove entry from allowlist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/whitelists":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to retrieve allowlist entries from","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of records to return (optional, default: 100, max: 1000)","required":false,"schema":{"type":"integer","example":""}},{"name":"page","in":"query","description":"Page direction relative to the above address, can be `next`, `previous` or `last`, if empty, returns the first page","required":false,"schema":{"type":"string","example":""}},{"name":"address","in":"query","description":"address serving as a \"divider\" between pages","required":true,"schema":{"type":"string","example":""}},{"name":"term","in":"query","description":"Filter records based on addresses that start with the specified substring.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist/get-v3--domainid--whitelists.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/whitelists"},"summary":"List allowlist records for domain","description":"List allowlist records for domain","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to add the allowlist entry to","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist/post-v3--domainid--whitelists.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/whitelists"},"summary":"Add allowlist record","description":"Add allowlist record","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Suppressions"],"parameters":[{"name":"domain_name","in":"path","description":"Domain to delete allowlist entries from","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist/delete-v3--domainid--whitelists.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/whitelists"},"summary":"Clear allowlist","description":"Clear allowlist","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/routes":{"post":{"tags":["Routes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/post-v3-routes.md","api_endpoint":"https://api.mailgun.net/v3/routes"},"summary":"Create a route","description":"Create a route","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Routes"],"parameters":[{"name":"skip","in":"query","description":"Number of records to skip. Defaults to 0.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of records to return. Defaults to 100.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes.md","api_endpoint":"https://api.mailgun.net/v3/routes"},"summary":"Get all routes","description":"Get all routes","security":[{"bearerAuth":[]}]}},"/v3/routes/{id}":{"get":{"tags":["Routes"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the route","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-id.md","api_endpoint":"https://api.mailgun.net/v3/routes/{id}"},"summary":"Get a route","description":"Get a route","security":[{"bearerAuth":[]}]},"put":{"tags":["Routes"],"parameters":[{"name":"id","in":"path","description":"ID of the route","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/put-v3-routes-id.md","api_endpoint":"https://api.mailgun.net/v3/routes/{id}"},"summary":"Update a route","description":"Update a route","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Routes"],"parameters":[{"name":"id","in":"path","description":"ID of the route","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/delete-v3-routes-id.md","api_endpoint":"https://api.mailgun.net/v3/routes/{id}"},"summary":"Delete a route","description":"Delete a route","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/routes/match":{"get":{"tags":["Routes"],"parameters":[{"name":"address","in":"query","description":"address to match routes on","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-match.md","api_endpoint":"https://api.mailgun.net/v3/routes/match"},"summary":"Match address to route","description":"Match address to route","security":[{"bearerAuth":[]}]}},"/v3/lists":{"post":{"tags":["Mailing Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-v3-lists.md","api_endpoint":"https://api.mailgun.net/v3/lists"},"summary":"Create a mailing list","description":"Create a mailing list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"A valid email address for the mailing list, e.g. developers@mailgun.net, or Developers <devs@mg.net>","required":true},"name":{"type":"string","description":"Mailing list name, e.g. Developers"},"description":{"type":"string","description":"A description"},"access_level":{"type":"string","description":"List access level, one of: readonly, members, everyone. Defaults to readonly"},"reply_preference":{"type":"string","description":"Set where replies should go: list or sender. Defaults to list"}}},"example":{"address":"","name":"","description":"","access_level":"","reply_preference":""}}}}},"get":{"tags":["Mailing Lists"],"parameters":[{"name":"limit","in":"query","description":"Set limit for the list length returned. Defaults to 100.","required":false,"schema":{"type":"string","example":""}},{"name":"skip","in":"query","description":"Skip the first n values in the list. Defaults to 0.","required":false,"schema":{"type":"string","example":""}},{"name":"address","in":"query","description":"Filter mailing lists matching a specific address","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists.md","api_endpoint":"https://api.mailgun.net/v3/lists"},"summary":"Get mailing lists","description":"Get mailing lists","security":[{"bearerAuth":[]}]}},"/v3/lists/{list_address}/members":{"get":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}},{"name":"address","in":"query","description":"A valid email address specification.","required":false,"schema":{"type":"string","example":""}},{"name":"subscribed","in":"query","description":"Filtering list on whether the member is subscribed or not.","required":false,"schema":{"type":"boolean","example":""}},{"name":"limit","in":"query","description":"Maximum number of records to return. Max is 100. Defaults to 100.","required":false,"schema":{"type":"integer","example":""}},{"name":"skip","in":"query","description":"skip","required":false,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-string:list_address-members.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members"},"summary":"Get mailing lists members","description":"Get mailing lists members","security":[{"bearerAuth":[]}]},"post":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-string:list_address-members.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members"},"summary":"Create a mailing list member","description":"Create a mailing list member","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"Valid email address specification."},"name":{"type":"string","description":"An optional member name."},"vars":{"type":"object","description":"JSON-encoded dictionary string with arbitrary parameters.","properties":{"key":{"type":"string","description":"Arbitrary key-value pair. Any valid JSON string key with a string, number, or boolean value."}}},"subscribed":{"type":"boolean","description":"Set the member as subscribed or not. Defaults to true."},"upsert":{"type":"boolean","description":"Set to True to update member if present, False to raise error in case of a duplicate member. Defaults to false."}}},"example":{"address":"","name":"","vars":{},"subscribed":"","upsert":""}}}}}},"/v3/lists/{list_address}/members.json":{"post":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}},{"name":"members","in":"query","description":"Mailing list recipients in JSON array format. Can be, either, an array of string addresses or an array of ListMemberRequest JSON objects.","required":true,"schema":{"type":"string","example":""}},{"name":"upsert","in":"query","description":"If true, an existing member will be updated. Defaults to false.","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-list_address-members.json.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members.json"},"summary":"Bulk upload members to a mailing list (JSON)","description":"Bulk upload members to a mailing list (JSON)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/lists/{list_address}/members.csv":{"post":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-list_address-members.csv.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members.csv"},"summary":"Bulk upload members to a mailing list (CSV)","description":"Bulk upload members to a mailing list (CSV)","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subscribed":{"type":"boolean","description":"subscribed"},"upsert":{"type":"boolean","description":"upsert"},"members":{"type":"string","description":"Absolute path to the CSV file"}}},"example":{"subscribed":"","upsert":"","members":""}}}}}},"/v3/lists/{list_address}/members/{member_address}":{"get":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}},{"name":"member_address","in":"path","description":"The member's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-member_address.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members/{member_address}"},"summary":"Get a member","description":"Get a member","security":[{"bearerAuth":[]}]},"put":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}},{"name":"member_address","in":"path","description":"The member's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-lists-list_address-members-member_address.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members/{member_address}"},"summary":"Update a mailing list member","description":"Update a mailing list member","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"A valid email address specification."},"name":{"type":"string","description":"An optional member name."},"vars":{"type":"object","description":"JSON-encoded dictionary string with arbitrary parameters.","properties":{"key":{"type":"string","description":"Arbitrary key-value pair. Any valid JSON string key with a string, number, or boolean value."}}},"subscribed":{"type":"boolean","description":"Set the member to subscribed or not. Defaults to True."}}},"example":{"address":"","name":"","vars":{},"subscribed":""}}}}},"delete":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}},{"name":"member_address","in":"path","description":"The member's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-lists-list_address-members-member_address.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members/{member_address}"},"summary":"Delete a member","description":"Delete a member","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/lists/{list_address}":{"put":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-v3-lists-address.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}"},"summary":"Update a mailing list","description":"Update a mailing list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"The new mailing list address."},"description":{"type":"string","description":"description"},"name":{"type":"string","description":"name"},"access_level":{"type":"string","description":"One of: readonly, members, everyone. Defaults to readonly."},"reply_reference":{"type":"string","description":"Set where replies should go. Can be list or sender. Defaults to list."},"list-id":{"type":"string","description":"list-id"}}},"example":{"address":"","description":"","name":"","access_level":"","reply_reference":"","list-id":""}}}}},"delete":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-v3-lists-address.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}"},"summary":"Delete a mailing list","description":"Delete a mailing list","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists-address.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}"},"summary":"Get a mailing list by address","description":"Get a mailing list by address","security":[{"bearerAuth":[]}]}},"/v3/lists/pages":{"get":{"tags":["Mailing Lists"],"parameters":[{"name":"limit","in":"query","description":"Set limit for the list length returned. Defaults to 100.","required":false,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists-pages.md","api_endpoint":"https://api.mailgun.net/v3/lists/pages"},"summary":"Get mailing lists by page","description":"Get mailing lists by page","security":[{"bearerAuth":[]}]}},"/v3/lists/{list_address}/members/pages":{"get":{"tags":["Mailing Lists"],"parameters":[{"name":"list_address","in":"path","description":"The mailing list's address","required":true,"schema":{"type":"string","example":""}},{"name":"subscribed","in":"query","description":"Filtering list on whether the member is subscribed or not.","required":false,"schema":{"type":"boolean","example":""}},{"name":"limit","in":"query","description":"Set limit for the list length returned. Defaults to 100.","required":false,"schema":{"type":"integer","example":""}},{"name":"address","in":"query","description":"Use as pivot for pagination.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Could be either: first, last, next or prev","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-pages.md","api_endpoint":"https://api.mailgun.net/v3/lists/{list_address}/members/pages"},"summary":"Get members by page","description":"Get members by page","security":[{"bearerAuth":[]}]}},"/v3/{domain_name}/templates":{"get":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name to fetch the templates for.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Name of the page to retrieve. Value can be `first`, `last`, `next`, or `previous`. Defaults to `first`.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Number of templates to retrieve. Default and max limit is 100.","required":false,"schema":{"type":"integer","example":""}},{"name":"p","in":"query","description":"Pivot used to retrieve the next page of templates.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates"},"summary":"Get templates","description":"Get templates","security":[{"bearerAuth":[]}]},"post":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/post-v3--domain-name--templates.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates"},"summary":"Create a template","description":"Create a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name of the template being stored. Supports utf-8 characters and name will be down cased.","required":true},"description":{"type":"string","description":"Description of the template being stored"},"createdBy":{"type":"string","description":"Optional metadata field api user can indicate who created the template."},"template":{"type":"string","description":"Content of the template."},"tag":{"type":"string","description":"Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value `initial` is used."},"comment":{"type":"string","description":"Version comment. This is valid only if a new version is being created. (template parameter is provided.)"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names `From`, `Subject`, and `Reply-To` are the only ones currently supported.  These headers will be inserted into the MIME at the time we attempt delivery.   Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to `postmaster@your-sending-domain.tld`"}}},"example":{"name":"","description":"","createdBy":"","template":"","tag":"","comment":"","headers":""}}}}},"delete":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates"},"summary":"Delete all templates","description":"Delete all templates","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/templates/{template_name}/versions":{"get":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name to fetch the templates for.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name to fetch the versions for.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Name of the page to retrieve. Value can be `first`, `last`, `next`, or `previous`. Defaults to `first`.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Number of templates to retrieve. Default and max limit is 100.","required":false,"schema":{"type":"integer","example":""}},{"name":"p","in":"query","description":"Pivot used to retrieve the next page of templates.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name--versions.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/versions"},"summary":"Get all template versions","description":"Get all template versions","security":[{"bearerAuth":[]}]},"post":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name to create the new version for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/post-v3--domain-name--templates--template-name--versions.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/versions"},"summary":"Create a template version","description":"Create a template version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"template":{"type":"string","description":"Content of the template.","required":true},"tag":{"type":"string","description":"Tag of the version that is being created. Must be unique to the template.","required":true},"comment":{"type":"string","description":"Comment related to the version that is being created."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names `From`, `Subject`, and `Reply-To` are the only ones currently supported.  These headers will be inserted into the MIME at the time we attempt delivery.   Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to `postmaster@your-sending-domain.tld`"}}},"example":{"template":"","tag":"","comment":"","active":"","headers":""}}}}}},"/v3/{domain_name}/templates/{template_name}":{"get":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name to fetch.","required":true,"schema":{"type":"string","example":""}},{"name":"active","in":"query","description":"If this flag is set to yes the active version of the template is included in the response.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}"},"summary":"Get template","description":"Get template","security":[{"bearerAuth":[]}]},"put":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"The template name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}"},"summary":"Update template","description":"Update template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Update description of the template being updated.","required":true}}},"example":{"description":""}}}}},"delete":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name to be deleted.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates--template-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}"},"summary":"Delete a template","description":"Delete a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/templates/{template_name}/versions/{version_name}":{"get":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name the version is for.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version of the template to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/get-v3--domain-name--templates--template-name--versions--version-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/versions/{version_name}"},"summary":"Get a version","description":"Get a version","security":[{"bearerAuth":[]}]},"put":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name the version is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version of the template to be updated","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/versions/{version_name}"},"summary":"Update a version","description":"Update a version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"template":{"type":"string","description":"Content of the template."},"comment":{"type":"string","description":"Comment related to the version that is being created."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names `From`, `Subject`, and `Reply-To` are the only ones currently supported.  These headers will be inserted into the MIME at the time we attempt delivery."}}},"example":{"template":"","comment":"","active":"","headers":""}}}}},"delete":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name the version is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version of the template to be deleted.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/delete-v3--domain-name--templates--template-name--versions--version-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/versions/{version_name}"},"summary":"Delete a version","description":"Delete a version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/templates/{template_name}/copy":{"put":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"The name of the source template","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--copy.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/copy"},"summary":"Copy a template","description":"Copy a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"requests":{"type":"array","description":"List of copy requests","required":true,"items":{"type":"object"}},"source_versions":{"type":"array","description":"Versions to copy or all versions if empty.","items":{"type":"string"}}}},"example":{"requests":[],"source_versions":["v1","v2"]}}}}}},"/v3/{domain_name}/templates/{template_name}/versions/{version_name}/copy/{new_version_name}":{"put":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"Template name the version is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version to copy.","required":true,"schema":{"type":"string","example":""}},{"name":"new_version_name","in":"path","description":"The name for the new version. If the version name already exists, the copy will fail.","required":true,"schema":{"type":"string","example":""}},{"name":"comment","in":"query","description":"Comment to be used for the new version.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--versions--version-name--copy--new-version-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/versions/{version_name}/copy/{new_version_name}"},"summary":"Copy a version","description":"Copy a version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/{domain_name}/templates/{template_name}/rename/{new_template_name}":{"put":{"tags":["Templates"],"parameters":[{"name":"domain_name","in":"path","description":"Domain name the template is associated with.","required":true,"schema":{"type":"string","example":""}},{"name":"template_name","in":"path","description":"The current name of the template.","required":true,"schema":{"type":"string","example":""}},{"name":"new_template_name","in":"path","description":"The name for the new template.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-templates/put-v3--domain-name--templates--template-name--rename--new-template-name-.md","api_endpoint":"https://api.mailgun.net/v3/{domain_name}/templates/{template_name}/rename/{new_template_name}"},"summary":"Rename a template","description":"Rename a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/templates":{"get":{"tags":["Templates"],"parameters":[{"name":"page","in":"query","description":"Name of the page to retrieve. Value can be `first`, `last`, `next`, or `previous`. Defaults to `first`.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Number of templates to retrieve. Default and max limit is 100.","required":false,"schema":{"type":"integer","example":""}},{"name":"p","in":"query","description":"Pivot used to retrieve the next page of templates.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates.md","api_endpoint":"https://api.mailgun.net/v4/templates"},"summary":"Get account-level templates","description":"Get account-level templates","security":[{"bearerAuth":[]}]},"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/post-v4-templates.md","api_endpoint":"https://api.mailgun.net/v4/templates"},"summary":"Create an account-level template","description":"Create an account-level template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name of the template being stored. Supports utf-8 characters and name will be down cased.","required":true},"description":{"type":"string","description":"Description of the template being stored"},"createdBy":{"type":"string","description":"Optional metadata field api user can indicate who created the template."},"template":{"type":"string","description":"Content of the template."},"tag":{"type":"string","description":"Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value `initial` is used."},"comment":{"type":"string","description":"Version comment. This is valid only if a new version is being created. (template parameter is provided.)"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names `From`, `Subject`, and `Reply-To` are the only ones currently supported."}}},"example":{"name":"","description":"","createdBy":"","template":"","tag":"","comment":"","headers":""}}}}},"delete":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates.md","api_endpoint":"https://api.mailgun.net/v4/templates"},"summary":"Delete all account-level templates","description":"Delete all account-level templates","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/templates/{template_name}/versions":{"get":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name to fetch the versions for.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Name of the page to retrieve. Value can be `first`, `last`, `next`, or `previous`. Defaults to `first`.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Number of versions to retrieve. Default and max limit is 100.","required":false,"schema":{"type":"integer","example":""}},{"name":"p","in":"query","description":"Pivot used to retrieve the next page of versions.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name--versions.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/versions"},"summary":"Get all account-level template versions","description":"Get all account-level template versions","security":[{"bearerAuth":[]}]},"post":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name to create the new version for.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/post-v4-templates--template-name--versions.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/versions"},"summary":"Create an account-level template version","description":"Create an account-level template version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"template":{"type":"string","description":"Content of the template.","required":true},"tag":{"type":"string","description":"Tag of the version that is being created. Must be unique to the template.","required":true},"comment":{"type":"string","description":"Comment related to the version that is being created."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template."}}},"example":{"template":"","tag":"","comment":"","active":"","headers":""}}}}}},"/v4/templates/{template_name}":{"get":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name to fetch.","required":true,"schema":{"type":"string","example":""}},{"name":"active","in":"query","description":"If this flag is set to yes the active version of the template is included in the response.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}"},"summary":"Get an account-level template","description":"Get an account-level template","security":[{"bearerAuth":[]}]},"put":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"The template name.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}"},"summary":"Update an account-level template","description":"Update an account-level template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Update description of the template being updated.","required":true}}},"example":{"description":""}}}}},"delete":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name to be deleted.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates--template-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}"},"summary":"Delete an account-level template","description":"Delete an account-level template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/templates/{template_name}/versions/{version_name}":{"get":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name the version is for.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version of the template to fetch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/get-v4-templates--template-name--versions--version-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/versions/{version_name}"},"summary":"Get an account-level template version","description":"Get an account-level template version","security":[{"bearerAuth":[]}]},"put":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name the version is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version of the template to be updated.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--versions--version-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/versions/{version_name}"},"summary":"Update an account-level template version","description":"Update an account-level template version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"template":{"type":"string","description":"Content of the template."},"comment":{"type":"string","description":"Comment related to the version."},"active":{"type":"string","description":"If this flag is set to yes, this version becomes active"},"headers":{"type":"string","description":"Key value JSON object of headers to be stored with the template."}}},"example":{"template":"","comment":"","active":"","headers":""}}}}},"delete":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name the version is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version of the template to be deleted.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/delete-v4-templates--template-name--versions--version-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/versions/{version_name}"},"summary":"Delete an account-level template version","description":"Delete an account-level template version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/templates/{template_name}/copy":{"put":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"The name of the source template","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--copy.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/copy"},"summary":"Copy a template","description":"Copy a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"requests":{"type":"array","description":"List of copy requests","required":true,"items":{"type":"object"}},"source_versions":{"type":"array","description":"Versions to copy or all versions if empty.","items":{"type":"string"}}}},"example":{"requests":[],"source_versions":["v1","v2"]}}}}}},"/v4/templates/{template_name}/versions/{version_name}/copy/{new_version_name}":{"put":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"Template name the version is stored under.","required":true,"schema":{"type":"string","example":""}},{"name":"version_name","in":"path","description":"Tag of the version to copy.","required":true,"schema":{"type":"string","example":""}},{"name":"new_version_name","in":"path","description":"The name for the new version. If the version name already exists, the copy will fail.","required":true,"schema":{"type":"string","example":""}},{"name":"comment","in":"query","description":"Comment to be used for the new version.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--versions--version-name--copy--new-version-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/versions/{version_name}/copy/{new_version_name}"},"summary":"Copy an account-level template version","description":"Copy an account-level template version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v4/templates/{template_name}/rename/{new_template_name}":{"put":{"tags":["Templates"],"parameters":[{"name":"template_name","in":"path","description":"The current name of the template.","required":true,"schema":{"type":"string","example":""}},{"name":"new_template_name","in":"path","description":"The name for the new template.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-templates/put-v4-templates--template-name--rename--new-template-name-.md","api_endpoint":"https://api.mailgun.net/v4/templates/{template_name}/rename/{new_template_name}"},"summary":"Rename a template","description":"Rename a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts":{"put":{"tags":["Account Management"],"parameters":[{"name":"name","in":"query","description":"The new account organization name","required":false,"schema":{"type":"string","example":""}},{"name":"inactive_session_timeout","in":"query","description":"The login session timeout period for inactivity","required":false,"schema":{"type":"integer","example":""}},{"name":"absolute_session_timeout","in":"query","description":"The login session timeout period limit","required":false,"schema":{"type":"integer","example":""}},{"name":"logout_redirect_url","in":"query","description":"The url to redirect to upon logout","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/put-v5-accounts.md","api_endpoint":"https://api.mailgun.net/v5/accounts"},"summary":"Update variable account settings","description":"Update variable account settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/http_signing_key":{"get":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-accounts-http_signing_key.md","api_endpoint":"https://api.mailgun.net/v5/accounts/http_signing_key"},"summary":"Get webhook signing key saved on the account","description":"Get webhook signing key saved on the account","security":[{"bearerAuth":[]}]},"post":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-http_signing_key.md","api_endpoint":"https://api.mailgun.net/v5/accounts/http_signing_key"},"summary":"Create or regenerate webhook signing key on an account","description":"Create or regenerate webhook signing key on an account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/sandbox/auth_recipients":{"get":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-sandbox-auth_recipients.md","api_endpoint":"https://api.mailgun.net/v5/sandbox/auth_recipients"},"summary":"Get authorized email recipients for a sandbox domain","description":"Get authorized email recipients for a sandbox domain","security":[{"bearerAuth":[]}]},"post":{"tags":["Account Management"],"parameters":[{"name":"email","in":"query","description":"The email address of the new recipient","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-sandbox-auth_recipients.md","api_endpoint":"https://api.mailgun.net/v5/sandbox/auth_recipients"},"summary":"Add authorized email recipient for a sandbox domain","description":"Add authorized email recipient for a sandbox domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/sandbox/auth_recipients/{email}":{"delete":{"tags":["Account Management"],"parameters":[{"name":"email","in":"path","description":"The email address of the authorized recipient to be removed","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/delete-v5-sandbox-auth_recipients-email.md","api_endpoint":"https://api.mailgun.net/v5/sandbox/auth_recipients/{email}"},"summary":"Remove an authorized sandbox domain email recipient","description":"Remove an authorized sandbox domain email recipient","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/resend_activation_email":{"post":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-resend_activation_email.md","api_endpoint":"https://api.mailgun.net/v5/accounts/resend_activation_email"},"summary":"Resend account activation email to the account owner","description":"Resend account activation email to the account owner","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/subaccounts/{subaccount_id}":{"get":{"tags":["Subaccounts"],"parameters":[{"name":"subaccount_id","in":"path","description":"The ID of the subaccount","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}"},"summary":"Get a single subaccount","description":"Get a single subaccount","security":[{"bearerAuth":[]}]}},"/v5/accounts/subaccounts":{"get":{"tags":["Subaccounts"],"parameters":[{"name":"sort","in":"query","description":"Sort order","required":false,"schema":{"type":"string","example":""}},{"name":"filter","in":"query","description":"Name of account to filter by","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Number of subaccounts to return","required":false,"schema":{"type":"integer","example":""}},{"name":"skip","in":"query","description":"Number of subaccounts to skip","required":false,"schema":{"type":"integer","example":""}},{"name":"enabled","in":"query","description":"Indicate to include enabled subaccounts (true) or disabled accounts (false). Leave unspecified to allow for either, depending on other parameters provided.","required":false,"schema":{"type":"boolean","example":""}},{"name":"closed","in":"query","description":"Indicate to include closed subaccounts (true) or exclude closed accounts (false). Leave unspecified to allow for either, depending on other parameters provided.","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts"},"summary":"List all subaccounts","description":"List all subaccounts","security":[{"bearerAuth":[]}]},"post":{"tags":["Subaccounts"],"parameters":[{"name":"name","in":"query","description":"The name of the subaccount","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts"},"summary":"Create a subaccount","description":"Create a subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/delete-v5-accounts-subaccounts-subaccount_id.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts"},"summary":"Delete a subaccount","description":"Delete a subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/subaccounts/{subaccount_id}/disable":{"post":{"tags":["Subaccounts"],"parameters":[{"name":"subaccount_id","in":"path","description":"The ID of the subaccount","required":true,"schema":{"type":"string","example":""}},{"name":"reason","in":"query","description":"The reason for disabling the subaccount","required":false,"schema":{"type":"string","example":""}},{"name":"note","in":"query","description":"A note for the subaccount","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-disable.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}/disable"},"summary":"Disable a subaccount","description":"Disable a subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/subaccounts/{subaccount_id}/enable":{"post":{"tags":["Subaccounts"],"parameters":[{"name":"subaccount_id","in":"path","description":"The ID of the subaccount","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}/enable"},"summary":"Enable a subaccount","description":"Enable a subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly":{"get":{"tags":["Subaccounts"],"parameters":[{"name":"subaccount_id","in":"path","description":"The ID of the subaccount","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly"},"summary":"Get current custom sending limit","description":"Get current custom sending limit","security":[{"bearerAuth":[]}]},"put":{"tags":["Subaccounts"],"parameters":[{"name":"subaccount_id","in":"path","description":"The ID of the subaccount","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The limit to set","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly"},"summary":"Set a custom sending limit","description":"Set a custom sending limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Subaccounts"],"parameters":[{"name":"subaccount_id","in":"path","description":"The ID of the subaccount","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/delete-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}/limit/custom/monthly"},"summary":"Delete a custom sending limit","description":"Delete a custom sending limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/limit/custom/monthly":{"get":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/get-v5-accounts-limit-custom-monthly.md","api_endpoint":"https://api.mailgun.net/v5/accounts/limit/custom/monthly"},"summary":"Get current custom sending limit","description":"Get current custom sending limit","security":[{"bearerAuth":[]}]},"put":{"tags":["Account Management"],"parameters":[{"name":"limit","in":"query","description":"The limit to set","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-monthly.md","api_endpoint":"https://api.mailgun.net/v5/accounts/limit/custom/monthly"},"summary":"Set a custom sending limit","description":"Set a custom sending limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/delete-v5-accounts-limit-custom-monthly.md","api_endpoint":"https://api.mailgun.net/v5/accounts/limit/custom/monthly"},"summary":"Delete a custom sending limit","description":"Delete a custom sending limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/limit/custom/enable":{"put":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-enable.md","api_endpoint":"https://api.mailgun.net/v5/accounts/limit/custom/enable"},"summary":"Re-enable account disabled for hitting send limit","description":"Re-enable account disabled for hitting send limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v5/accounts/subaccounts/{subaccount_id}/features":{"put":{"tags":["Subaccounts"],"parameters":[{"name":"subaccount_id","in":"path","description":"The ID of the subaccount","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-features.md","api_endpoint":"https://api.mailgun.net/v5/accounts/subaccounts/{subaccount_id}/features"},"summary":"Update subaccount feature","description":"Update subaccount feature","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/keys":{"get":{"tags":["Account Management"],"parameters":[{"name":"domain_name","in":"query","description":"Domain name filter for domain keys","required":false,"schema":{"type":"string","example":""}},{"name":"kind","in":"query","description":"Key kind filter","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/keys/get-v1-keys.md","api_endpoint":"https://api.mailgun.net/v1/keys"},"summary":"List Mailgun API keys","description":"List Mailgun API keys","security":[{"bearerAuth":[]}]},"post":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/keys/post-v1-keys.md","api_endpoint":"https://api.mailgun.net/v1/keys"},"summary":"Create Mailgun API key","description":"Create Mailgun API key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain_name":{"type":"string","description":"Web domain to associate with the key, for keys of 'domain' kind"},"kind":{"type":"string","description":"Type of API key ('domain', 'user', or 'web'). Defaults to 'user' if not provided. Note: web keys are not subject to IP allowlisting and have a default/maximum validity period of 1 day."},"description":{"type":"string","description":"Key description"},"expiration":{"type":"integer","description":"Key lifetime in seconds, must be greater than 0 if set"},"role":{"type":"string","description":"Key role ('admin', 'basic' [use in place of analyst], 'sending' [use with keys of domain kind], or 'developer')","required":true},"user_id":{"type":"string","description":"API Key user's string user ID; should be provided for all keys of 'web' kind"},"user_name":{"type":"string","description":"API Key user's name"},"email":{"type":"string","description":"API Key user's email address; should be provided for all keys of 'web' kind"}}},"example":{"domain_name":"","kind":"","description":"","expiration":"","role":"","user_id":"","user_name":"","email":""}}}}}},"/v1/keys/{key_id}":{"delete":{"tags":["Account Management"],"parameters":[{"name":"key_id","in":"path","description":"The Key ID generated by Mailgun on key creation","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/keys/delete-v1-keys--key-id-.md","api_endpoint":"https://api.mailgun.net/v1/keys/{key_id}"},"summary":"Delete Mailgun API key","description":"Delete Mailgun API key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/keys/public":{"post":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/keys/post-v1-keys-public.md","api_endpoint":"https://api.mailgun.net/v1/keys/public"},"summary":"Regenerate Mailgun Public API key","description":"Regenerate Mailgun Public API key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{domain_name}/credentials":{"get":{"tags":["Account Management"],"parameters":[{"name":"domain_name","in":"path","description":"Hostname filter for credential results","required":true,"schema":{"type":"string","example":""}},{"name":"skip","in":"query","description":"Number of results to skip, to help with pagination","required":false,"schema":{"type":"integer","example":""}},{"name":"limit","in":"query","description":"Limit results to this many","required":false,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/credentials/get-v3-domains--domain-name--credentials.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/credentials"},"summary":"List Mailgun SMTP credential metadata for a given domain","description":"List Mailgun SMTP credential metadata for a given domain","security":[{"bearerAuth":[]}]},"post":{"tags":["Account Management"],"parameters":[{"name":"domain_name","in":"path","description":"Hostname for new credentials","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/credentials/post-v3-domains--domain-name--credentials.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/credentials"},"summary":"Create Mailgun SMTP credentials for a given domain","description":"Create Mailgun SMTP credentials for a given domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"login":{"type":"string","description":"Email address of SMTP credential user; accepts multiple values","required":true},"mailbox":{"type":"string","description":"Email address of SMTP credential user, may be used in place of 'login'; accepts multiple values"},"system":{"type":"boolean","description":"Identify if these are system account credentials, defaults to false"},"password":{"type":"string","description":"Supply desired password(s) for the new credentials if preferred over generated ones; accepts multiple values"}}},"example":{"login":"","mailbox":"","system":"","password":""}}}}},"delete":{"tags":["Account Management"],"parameters":[{"name":"domain_name","in":"path","description":"Hostname of credentials to be deleted","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/credentials/delete-v3-domains--domain-name--credentials.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/credentials"},"summary":"Delete all Mailgun SMTP credentials for a domain","description":"Delete all Mailgun SMTP credentials for a domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v3/domains/{domain_name}/credentials/{spec}":{"put":{"tags":["Account Management"],"parameters":[{"name":"domain_name","in":"path","description":"Hostname of credentials to be updated","required":true,"schema":{"type":"string","example":""}},{"name":"spec","in":"path","description":"Login specification of credentials to be updated (email address)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/credentials/put-v3-domains--domain-name--credentials--spec-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/credentials/{spec}"},"summary":"Update Mailgun SMTP credentials","description":"Update Mailgun SMTP credentials","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"password":{"type":"string","description":"Supply desired password for the credentials to update if preferred over a generated one"}}},"example":{"password":""}}}}},"delete":{"tags":["Account Management"],"parameters":[{"name":"domain_name","in":"path","description":"Hostname of credentials to be deleted","required":true,"schema":{"type":"string","example":""}},{"name":"spec","in":"path","description":"Login specification of credentials to be deleted (email address)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/credentials/delete-v3-domains--domain-name--credentials--spec-.md","api_endpoint":"https://api.mailgun.net/v3/domains/{domain_name}/credentials/{spec}"},"summary":"Delete Mailgun SMTP credentials","description":"Delete Mailgun SMTP credentials","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v2/ip_whitelist":{"get":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-allowlist/get-v2-ip-whitelist.md","api_endpoint":"https://api.mailgun.net/v2/ip_whitelist"},"summary":"List Mailgun account IP allowlist entries","description":"List Mailgun account IP allowlist entries","security":[{"bearerAuth":[]}]},"put":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-allowlist/put-v2-ip-whitelist.md","api_endpoint":"https://api.mailgun.net/v2/ip_whitelist"},"summary":"Update individual Mailgun account IP allowlist entry's description","description":"Update individual Mailgun account IP allowlist entry's description","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"Address to be updated in the allowlist","required":true},"description":{"type":"string","description":"Description of the address to be updated in the allowlist, defaults to empty string"}}},"example":{"address":"","description":""}}}}},"post":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-allowlist/post-v2-ip-whitelist.md","api_endpoint":"https://api.mailgun.net/v2/ip_whitelist"},"summary":"Add Mailgun account IP allowlist entry","description":"Add Mailgun account IP allowlist entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"Address to be added to the allowlist","required":true},"description":{"type":"string","description":"Description of the address to be added to the allowlist, defaults to empty string"}}},"example":{"address":"","description":""}}}}},"delete":{"tags":["Account Management"],"parameters":[{"name":"address","in":"query","description":"Address to be deleted from allowlist","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-allowlist/delete-v2-ip-whitelist.md","api_endpoint":"https://api.mailgun.net/v2/ip_whitelist"},"summary":"Delete Mailgun account IP allowlist entry","description":"Delete Mailgun account IP allowlist entry","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/bounce-classification/stats":{"get":{"tags":["Suppressions"],"parameters":[{"name":"group","in":"query","description":"Group response by fields: subaccount.id, domain.name, entity-id, rule-id","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limits the number of items returned in a response","required":false,"schema":{"type":"integer","example":""}},{"name":"include_subaccounts","in":"query","description":"Include subaccounts","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-stats.md","api_endpoint":"https://api.mailgun.net/v1/bounce-classification/stats"},"summary":"List statistics, ordered by total bounces","description":"List statistics, ordered by total bounces","security":[{"bearerAuth":[]}]}},"/v1/bounce-classification/domains":{"get":{"tags":["Suppressions"],"parameters":[{"name":"limit","in":"query","description":"Limits the number of items returned in a response","required":false,"schema":{"type":"integer","example":""}},{"name":"skip","in":"query","description":"Skips N items in a response","required":false,"schema":{"type":"integer","example":""}},{"name":"query","in":"query","description":"Query filter, e.g.: 'domain.name:example.com'","required":false,"schema":{"type":"string","example":""}},{"name":"include_subaccounts","in":"query","description":"Include subaccounts","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains.md","api_endpoint":"https://api.mailgun.net/v1/bounce-classification/domains"},"summary":"List domains statistic per account","description":"List domains statistic per account","security":[{"bearerAuth":[]}]}},"/v1/bounce-classification/domains/{domain}/entities":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain","in":"path","description":"The sender domain name","required":true,"schema":{"type":"string","example":""}},{"name":"include_subaccounts","in":"query","description":"Include subaccounts","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--entities.md","api_endpoint":"https://api.mailgun.net/v1/bounce-classification/domains/{domain}/entities"},"summary":"List statistic per domain","description":"List statistic per domain","security":[{"bearerAuth":[]}]}},"/v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain","in":"path","description":"The sender domain name","required":true,"schema":{"type":"string","example":""}},{"name":"entity-id","in":"path","description":"The entity ID(Email Service Entity or Spam Filter / BL)","required":true,"schema":{"type":"string","example":""}},{"name":"include_subaccounts","in":"query","description":"Include subaccounts","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--entities--entity-id--rules.md","api_endpoint":"https://api.mailgun.net/v1/bounce-classification/domains/{domain}/entities/{entity-id}/rules"},"summary":"List statistic per entity","description":"List statistic per entity","security":[{"bearerAuth":[]}]}},"/v1/bounce-classification/domains/{domain}/events":{"get":{"tags":["Suppressions"],"parameters":[{"name":"domain","in":"path","description":"The sender domain name","required":true,"schema":{"type":"string","example":""}},{"name":"rule-id","in":"query","description":"Optional if 'page' is passed","required":false,"schema":{"type":"string","example":""}},{"name":"entity-id","in":"query","description":"The entity ID(Email Service Entity or Spam Filter / BL)","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Sort field and order. Default is '@timestamp:asc'","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Encoded paging information, provided via 'next', 'previous' links","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limits the number of items returned in a response","required":false,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-domains--domain--events.md","api_endpoint":"https://api.mailgun.net/v1/bounce-classification/domains/{domain}/events"},"summary":"List Bounce Logs","description":"List Bounce Logs","security":[{"bearerAuth":[]}]}},"/v1/bounce-classification/config/entities":{"get":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-config-entities.md","api_endpoint":"https://api.mailgun.net/v1/bounce-classification/config/entities"},"summary":"List entities","description":"List entities","security":[{"bearerAuth":[]}]}},"/v1/bounce-classification/config/rules":{"get":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/get-v1-bounce-classification-config-rules.md","api_endpoint":"https://api.mailgun.net/v1/bounce-classification/config/rules"},"summary":"List rules","description":"List rules","security":[{"bearerAuth":[]}]}},"/v2/bounce-classification/metrics":{"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/post-v2-bounce-classification-metrics.md","api_endpoint":"https://api.mailgun.net/v2/bounce-classification/metrics"},"summary":"List statistic v2","description":"List statistic v2","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"object","description":"A start timestamp (default: 7 days before current time). Must be in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format","properties":{"value":{"type":"string","description":"Start timestamp in RFC 2822 format."}}},"end":{"type":"object","description":"An end timestamp (default: current time). Must be in RFC 2822 format: https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#date-format","properties":{"value":{"type":"string","description":"End timestamp in RFC 2822 format."}}},"resolution":{"type":"object","description":"resolution","properties":{"value":{"type":"string","description":"Time resolution for aggregation.","enum":["hour","day","month"]}}},"duration":{"type":"string","description":"A duration in the format of '48h' '60m' '30s'. If duration is provided then it is calculated from the end date and overwrites the start date."},"dimensions":{"type":"array","description":"Dimensions.","items":{"type":"string"}},"metrics":{"type":"array","description":"Metrics to return. See example.","items":{"type":"string"}},"filter":{"type":"object","description":"Filters to apply to the query.","properties":{"AND":{"type":"array","description":"Array of filter conditions combined with AND logic."}}},"include_subaccounts":{"type":"boolean","description":"Include stats from all subaccounts."},"pagination":{"type":"object","description":"Attributes used for pagination and sorting.","properties":{"skip":{"type":"integer","description":"Number of items to skip from the beginning of the result set."},"limit":{"type":"integer","description":"Maximum number of items to return per page."}}}}},"example":{"start":{},"end":{},"resolution":{},"duration":"","dimensions":["bounce_category","domain"],"metrics":["bounce_count","classified_count"],"filter":{},"include_subaccounts":"","pagination":{}}}}}}},"/v5/users":{"get":{"tags":["Account Management"],"parameters":[{"name":"role","in":"query","description":"The user role by which to filter results (basic == analyst)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of users to return","required":false,"schema":{"type":"integer","example":""}},{"name":"skip","in":"query","description":"The number of users to skip","required":false,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/users/get-v5-users.md","api_endpoint":"https://api.mailgun.net/v5/users"},"summary":"Get users on an account","description":"Get users on an account","security":[{"bearerAuth":[]}]}},"/v5/users/{user_id}":{"get":{"tags":["Account Management"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user on the account","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-user_id.md","api_endpoint":"https://api.mailgun.net/v5/users/{user_id}"},"summary":"Get a user's details","description":"Get a user's details","security":[{"bearerAuth":[]}]}},"/v5/users/me":{"get":{"tags":["Account Management"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-me.md","api_endpoint":"https://api.mailgun.net/v5/users/me"},"summary":"Get one's own user details","description":"Get one's own user details","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}