Mailgun

https://documentation.mailgun.com/docs
Admin
Mailgun is a powerful email API platform that enables developers to send, receive, validate, and...
Tokens:452,984
Snippets:4,051
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Mailgun Go SDK with go get

Source: https://documentation.mailgun.com/docs/mailgun/sdk/go_sdk

Install the Mailgun Go SDK v5 using the go get command. Ensure you include the /v5 suffix in the import path when using Go modules.

```bash
$ go get github.com/mailgun/mailgun-go/v5
```

--------------------------------

### Example response for get test results

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inspect/email-preview/get-v1-preview-tests--test-id--results

Example JSON response showing the test results for two device configurations. The response includes device details, screenshots, and status.

```json
{
  "android10_gmailapp_pixel4_dm": {
    "id": "android10_gmailapp_pixel4_dm",
    "displayname": "Gmail App Pixel 4",
    "client": "Gmail App",
    "os": "Android 10 (Dark Mode)",
    "category": "Mobile",
    "browser": "",
    "screenshots": { … },
    "thumbnail": "https://images.emailonacid.com/1234",
    "fullthumbnail": "https://images.emailonacid.com/90479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257",
    "status": "Complete",
    "statusdetails": { … }
  },
  "android10_gmailapp_pixel4_lm": {
    "id": "android10_gmailapp_pixel4_lm",
    "displayname": "Gmail App Pixel 4",
    "client": "Gmail App",
    "os": "Android 10",
    "category": "Mobile",
    "browser": "",
    "screenshots": { … },
    "thumbnail": "https://images.emailonacid.com/YXBpLzRRZVp3Z0479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257",
    "fullthumbnail": "https://images.emailonacid.com/YXBpLzRRZVp3ZzlBbmJydjVEZjBUOW9obUxpU1RUQmpe=d90479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257",
    "status": "Complete",
    "statusdetails": { … }
  }
}
```

--------------------------------

### Example response for get a tag

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag

Example JSON response showing the tag details, including the tag name, description, and first/last seen timestamps.

```json
{
  "tag": "my-tag-1",
  "description": "Optional description",
  "first-seen": "2023-01-02 02:14:27 +0000 UTC",
  "last-seen": "2023-09-06 18:45:51 +0000 UTC"
}
```

--------------------------------

### Get Job V4 - 200 Response Example

Source: https://documentation.mailgun.com/docs/validate/oas/openapi-validate-final/bulk-validations/api.initv4api.%28%2Aapihelpers%29.isfreeorfishy.func1-8

Example 200 response body for the Get Job V4 request. Shows the structure with quantity, id, summary, download_url, status, and created_at fields.

```json
{
  "quantity": 10000,
  "id": "some-job-name",
  "summary": {
    "risk": { … },
    "result": { … }
  },
  "download_url": {
    "csv": "https://some-aws-or-gcp-host/file.csv.zip",
    "json": "https://some-aws-or-gcp-host/file.json.zip"
  },
  "status": "uploaded",
  "created_at": 160000000
}
```

--------------------------------

### Example response for match address to route

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-match

Example JSON response from the GET /v3/routes/match endpoint. Shows a route object with id, priority, description, expression, actions, and created_at fields.

```json
{
  "route": {
    "id": "4f3bad2335335426750048c6",
    "priority": 0,
    "description": "Sample route",
    "expression": "match_recipient(\".*@samples.mailgun.org\")",
    "actions": [ … ],
    "created_at": "Wed, 15 Feb 2012 13:03:31 GMT"
  }
}
```

--------------------------------

### 200 response for GET /v5/users/{user_id}

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/users/get-v5-users-user_id

Example 200 response for the GET /v5/users/{user_id} endpoint. Contains detailed user information including activation, role, authentication, and preferences.

```json
{
  "id": "123",
  "name": "John Doe",
  "activated": true,
  "is_disabled": false,
  "email": "johndoe@example.com",
  "email_details": {
    "address": "johndoe@example.com",
    "is_valid": true,
    "parts": { … }
  },
  "role": "basic",
  "account_id": "567",
  "opened_ip": "67.111.60.111",
  "is_master": true,
  "metadata": {},
  "tfa_enabled": true,
  "tfa_active": true,
  "tfa_created_at": "2022-12-20T16:52:01.892000",
  "password_updated_at": "2022-12-20T16:52:01.892000",
  "preferences": {
    "programming_language": "curl",
    "time_format": "%m/%d/%y %I:%M %p",
    "time_zone": "US/Eastern"
  },
  "auth": {
    "method": "sinch",
    "prior_details": {},
    "prior_method": ""
  },
  "github_user_id": null,
  "salesforce_user_id": null,
  "migration_status": "done"
}
```

--------------------------------

### Example response for get send alert

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/send-alerts/get-v1-thresholds-alerts-send--name-

Example JSON response for a successful request, showing the alert details including id, name, metric, comparator, limit, dimension, and period.

```json
{
  "id": "915ff385-0a9a-4087-86d5-6727ea7d9b49",
  "parent_account_id": "12345",
  "subaccount_id": "67890",
  "name": "delivery rate",
  "created_at": "2026-02-01T10:30:00Z",
  "updated_at": "2026-02-03T14:15:00Z",
  "last_checked": "2026-02-04T16:00:00Z",
  "alert_channels": [
    "email",
    "webhook",
    "slack"
  ],
  "metric": "delivered_rate",
  "comparator": "<",
  "limit": ".99",
  "dimension": "subaccount",
  "period": "1h"
}
```

--------------------------------

### Get Email Preview Test Info Response Example

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inspect/email-preview/get-v1-preview-tests--test-id-

Example response body for a successful retrieval of test info. Shows the subject, date, arrays of email statuses, and content checking results.

```json
{
  "subject": "string",
  "date": 0,
  "completed": [
    "string"
  ],
  "processing": [
    "string"
  ],
  "bounced": [
    "string"
  ],
  "content_checking": {
    "link_validation": { … },
    "image_validation": { … },
    "accessibility": { … },
    "code_analysis": { … }
  }
}
```

--------------------------------

### Example response for a specific result

Source: https://documentation.mailgun.com/docs/inboxready/inbox-placement-ir

Example response for getting a single result. Shows fields such as rid, keybox_email, subject, sender, name, created_at, updated_at, seed_results, and delivery stats.

```json
{
 "result": {
   "rid": "123456789012345678901234",
   "result_id": "12345678-1234-1234-1234-123456789012",
   "keybox_email": "ibp-00410325-1c95-492e-bc35-c19899802494@mailgun.net",
   "subject": "A subject of things",
   "sender": "person@domain.com",
   "name": "Such list",
   "created_at": "2021-08-03T14:20:40.301Z",
   "updated_at": "2021-08-03T14:36:53.841Z",
   "seed_results": [
     {
       "email": "mail@box.com",
       "provider": "box.com",
       "destination": "inbox",
       "state": "delivered",
       "originating_ip": "123.123.123.123",
       "tags": [
         "inbox"
       ],
       "spf": "pass",
       "dkim": "pass",
       "dmarc": "pass"
     }
   ]
 }
}
```

--------------------------------

### 200 response for GET /v3/stats/total

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats/get-v3-stats-total

Example JSON response body for a successful request. Contains fields like description, start, end, resolution, and stats array.

```json
{
  "description": "Optional Description",
  "start": "Tue, 14 Feb 2012 00:00:00 UTC",
  "end": "Fri, 01 Apr 2012 00:00:00 UTC",
  "resolution": "month",
  "stats": [
    { … }
  ]
}
```

--------------------------------

### Example response for getting a member

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-member_address

Example JSON response body for a successful GET request to the member endpoint. It shows the member's address, name, vars object, and subscribed boolean.

```json
{
  "address": "alice@example.com",
  "name": "Alice",
  "vars": {
    "gender": "female",
    "age": 27
  },
  "subscribed": true
}
```

--------------------------------

### Create a domain key - 200 response example

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/domain-keys/post-v1-dkim-keys

Example JSON response for a successful create request. Contains the signing_domain, selector, and a dns_record object with the TXT record details for DKIM.

```json
{
  "signing_domain": "example.com",
  "selector": "s1",
  "dns_record": {
    "cached": [],
    "name": "s1._domainkey.example.com",
    "record_type": "TXT",
    "valid": "unknown",
    "value": "k=rsa; p=<public_key>"
  }
}
```

--------------------------------

### Example response for getting a single seed list

Source: https://documentation.mailgun.com/docs/inboxready/inbox-placement-ir

Example response for getting a single seed list. Shows the structure of the seed list object, including delivery stats and results arrays.

```json
{
  "kid": "610abd2009b08f382ac86c45",
  "created_at": "2021-08-04T16:15:28.08Z",
  "updated_at": "2021-08-04T16:15:28.08Z",
  "last_result_at": "0001-01-01T00:00:00Z",
  "target_email": "ibp-seedlist-address@domain.net",
  "sending_domains": [
    "yourdomain.com"
  ],
  "has_results": false,
  "name": "My campaign inbox test",
  "seed_filter": ".*",
  "mailing_list": "ibp-seedlist-address@domain.net,another@email.com",
  "delivery_stats": {
    "all": {
      "delivered": 0,
      "missing": 0,
      "pending": 0,
      "spam": 0,
      "inbox": 0,
      "total": 0,
      "provider": "all"
    }
  },
  "results": [
    {
      "result_id": "12345678-1234-1234-1234-123456789012",
      "subject": "IBP Test - 1",
      "sender": "generated@yourdomain.com",
      "delivery_stats": {
        "all": {
          "delivered": 7,
          "missing": 0,
          "pending": 0,
          "spam": 2,
          "inbox": 5,
          "total": 7,
          "provider": "all",
          "categories": {}
        }
      }
    }
  ]
}
```

--------------------------------

### Set up basic dev environment with conda

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Sets up a basic development environment with a minimum number of dependencies using conda on Linux or macOS.

```bash
git clone https://github.com/mailgun/mailgun-python
cd mailgun-python
```

```bash
make dev
conda activate mailgun
```

--------------------------------

### Example response for GET /v5/users

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/users/get-v5-users

Shows a sample 200 response body containing a list of users and the total count. The 'total' field indicates the total number of users matching the query.

```json
{
  "users": [
    { … }
  ],
  "total": 1
}
```

--------------------------------

### 200 Response Example for Get All Code Analysis Versions

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inspect/code-analysis/get-v1-inspect-analyze--test-id--versions

Example 200 response body for the Get All Code Analysis Versions endpoint. Shows the meta object with a count of versions and an items object containing the list of versions.

```json
{
  "meta": {
    "count": 3
  },
  "items": {
    "versions": [ … ]
  }
}
```

--------------------------------

### 200 Response for POST /v3/ip_warmups/{addr}

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/ip-address-warmup/post-v3-ip-warmups--addr-

Example JSON response returned when the warmup plan is successfully created. Contains a message field with the value "success".

```json
{
  "message": "success"
}

```

--------------------------------

### Send an email with Mailgun Go SDK

Source: https://documentation.mailgun.com/docs/mailgun/sdk/go_sdk

Complete Go example that sends an email using the Mailgun SDK. It creates a Mailgun client with your private API key, builds a message with sender, subject, body, and recipient, and sends it with a 10-second timeout. The example includes commented lines for EU domain endpoint configuration and notes where to find your domain and API key.

```go
package main

import (
	"context"
	"fmt"
	"log"
	"time"

	"github.com/mailgun/mailgun-go/v5"
)

// Your available domain names can be found here:
// (https://app.mailgun.com/mg/sending/domains)
var yourDomain = "your-domain-name" // e.g. mg.yourcompany.com

// You can find the Private API Key in your Account Menu, under "Account Settings":
// (https://app.mailgun.com/settings/api_security)
var privateAPIKey = "your-private-key"

func main() {
	// Create an instance of the Mailgun Client
	mg := mailgun.NewMailgun(privateAPIKey)
	
	// When you have an EU domain, you must specify the endpoint:
	// mg.SetAPIBase(mailgun.APIBaseEU)

	sender := "sender@mg.yourcompany.com"
	subject := "Fancy subject!"
	body := "Hello from Mailgun Go!"
	recipient := "recipient@example.com"

	// The message object allows you to add attachments and Bcc recipients
	message := mg.NewMessage(yourDomain, sender, subject, body, recipient)

	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
	defer cancel()

	// Send the message with a 10-second timeout
	resp, err := mg.Send(ctx, message)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Printf("ID: %s Resp: %s\n", resp.ID, resp.Message)
}
```

--------------------------------

### Get Domains 200 Response

Source: https://documentation.mailgun.com/docs/inboxready/domains-ir

Example 200 response for the Get Domains endpoint. Contains an array of domain objects and paging information.

```json
{
  "items": [
    {
      "ID": "<ID>",
      "created_at": 123456789,
      "name": "example.com",
      "verified": {
        "verified_at": 123456789,
        "status": "inbox_ready"
      },
      "services": {
        "spam_trap_monitoring": true,
        "domain_blocklist_monitoring": true
      },
      "txt_record": "<HASHED TXT RECORD KEY>"
    },
    ...
  ],
  "paging": {
    "previous": "<URL>",
    "first": "<URL>",
    "next": "<URL>",
    "last": "<URL>"
  }
}
```

--------------------------------

### 200 Response body for GET /v5/sandbox/auth_recipients

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/account-management/get-v5-sandbox-auth_recipients

Example 200 response body for the GET /v5/sandbox/auth_recipients request. Contains a recipients array of objects (github.com-mailgun-accounts-api-RecipientResponse).

```json
{
  "recipients": [
    { … }
  ]
}
```

--------------------------------

### Sample Response - Create a list Health Preview

Source: https://documentation.mailgun.com/docs/validate/bulk_valid_preview

Sample JSON response for the create endpoint, confirming the bulk preview was submitted.

```json
{
  "id": "test_501",
  "message": "The bulk preview was submitted."
}
```

--------------------------------

### Get domains - 200 response

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains

Example JSON response for a successful GET /v4/domains request. It includes a total_count and an items array containing domain objects.

```json
{
  "total_count": 1,
  "items": [
    { … }
  ]
}
```

--------------------------------

### Example response for GET /v4/domains/{name}

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/domains/get-v4-domains--name-

Shows a 200 response body with domain details, including receiving and sending DNS records.

```json
{
  "domain": {
    "created_at": "Thu, 13 Oct 2011 18:02:00 GMT",
    "id": "123456789012345678901234",
    "name": "example.com",
    "require_tls": true,
    "smtp_login": "postmaster@example.com",
    "spam_action": "disabled",
    "state": "active",
    "type": "sandbox",
    "use_automatic_sender_security": true,
    "web_prefix": "email",
    "web_scheme": "http"
  },
  "receiving_dns_records": [
    { … },
    { … }
  ],
  "sending_dns_records": [
    { … },
    { … },
    { … }
  ]
}
```

--------------------------------

### Set up full dev environment with conda

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Sets up a full development environment using conda on Linux or macOS.

```bash
make dev-full
conda activate mailgun-dev
```

--------------------------------

### 200 response body for get domain webhooks by type

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/domain-webhooks/get-v3-domains--domain-name--webhooks--webhook-name-

Example 200 response body for the GET request. Contains a webhook object with a urls array listing the webhook URLs.

```json
{
  "webhook": {
    "urls": [ … ]
  }
}
```

--------------------------------

### POST /v3/ip_warmups/{addr}

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/ip-address-warmup/post-v3-ip-warmups--addr-

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

```APIDOC
## POST /v3/ip_warmups/{addr}

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

### Method
POST

### Endpoint
/v3/ip_warmups/{addr}

### Parameters
#### Path Parameters
- **addr** (string) - Required - The IP address to create the warmup plan for.

### Request Example
```
curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/ip_warmups/{addr}'
```

### Response
#### Success Response (200)
- **message** (string) - Response message

#### Response Example
```
{
  "message": "success"
}
```
```

--------------------------------

### 200 response body for get account-level webhook

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/account-webhooks/get-v1-webhooks--webhook-id-

Example 200 response body for the get account-level webhook request. Contains webhook_id, description, url, event_types, and created_at fields.

```json
{
  "webhook_id": "507f1f77bcf86cd799439011",
  "description": "Production alerts webhook",
  "url": "https://api.example.com/webhooks/mailgun",
  "event_types": [
    "delivered",
    "permanent_fail",
    "complained"
  ],
  "created_at": "2026-02-16T19:06:01Z"
}
```

--------------------------------

### 200 response for POST /v3/dynamic_pools/all

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/dynamic-ip-pools/post-v3-dynamic-pools-all

Example 200 response for the initialize/set IPs for all pools request. Shows the updated pool assignments.

```json
{
  "good_reputation": [
    "1.0.0.1",
    "1.0.0.2"
  ],
  "new_senders": [
    "1.0.0.4"
  ],
  "poor_reputation": [
    "1.0.0.3"
  ]
}
```

--------------------------------

### Send First Email with cURL

Source: https://documentation.mailgun.com/docs/mailgun/quickstart

Sends your first email using the sandbox domain. Replace YOUR_API_KEY and YOUR_SANDBOX_DOMAIN with your credentials. The response will be 200 ok with a message like "Queued. Thank you.".

```bash
curl --user 'api:YOUR_API_KEY' \
  https://api.mailgun.net/v3/YOUR_SANDBOX_DOMAIN/messages \
  -F from='Test <postmaster@YOUR_SANDBOX_DOMAIN>' \
  -F to='your-email@example.com' \
  -F subject='Hello!' \
  -F text='Test message'
```

--------------------------------

### Get GPT Domains 200 Response

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains-list

Example of a 200 response body for the Get GPT Domains endpoint. It contains a data array of domain entries and a total count.

```json
{
  "data": [
    { … }
  ],
  "total": 1
}
```

--------------------------------

### Create a mailing list via API

Source: https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/mailing-lists

Creates a mailing list with the specified address and description. Requires a valid API key and domain name.

```bash
curl -s --user 'api:YOUR_API_KEY' \
   https://api.mailgun.net/v3/lists \
   -F address='LIST@YOUR_DOMAIN_NAME' \
   -F description='Mailgun developers list'
```

--------------------------------

### 200 Response Body for GET /v1/inboxready/domains

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/domains

Example JSON response for a successful GET request. Contains an items array and a paging object with previous, first, next, and last URLs.

```json
{
  "items": [
    { … }
  ],
  "paging": {
    "previous": "https://....",
    "first": "https://....",
    "next": "https://....",
    "last": "https://...."
  }
}
```

--------------------------------

### Sample Response - Get a list of health previews

Source: https://documentation.mailgun.com/docs/validate/bulk_valid_preview

Sample JSON response for the list endpoint, containing an array of preview objects.

```json
{
  "previews": [
    {
      "id": "test_500",
      "valid": true,
      "status": "preview_complete",
      "quantity": 8,
      "created_at": 1590080191,
      "summary": {
        "result": {
          "deliverable": 37.5,
          "do_not_send": 0,
          "undeliverable": 23,
          "catch_all": 2,
          "unknown": 37.5
        },
        "risk": {
          "high": 25,
          "low": 25,
          "medium": 12.5,
          "unknown": 37.5
        }
      }
    },
    {
      "id": "test_501",
      "valid": true,
      "status": "preview_complete",
      "quantity": 8,
      "created_at": 1590155015,
      "summary": {
        "result": {
          "deliverable": 37.5,
          "do_not_send": 0,
          "undeliverable": 23,
          "catch_all": 2,
          "unknown": 37.5
        },
        "risk": {
          "high": 25,
          "low": 25,
          "medium": 12.5,
          "unknown": 37.5
        }
      }
    }
  ]
}
```

--------------------------------

### 200 Response Body for Get Monitored Domains

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains

Example 200 response body for the Get Monitored Domains endpoint. Contains an array of domain blocklist monitoring health records.

```json
{
  "domains": [
    { … },
    { … }
  ]
}
```

--------------------------------

### Install Composer

Source: https://documentation.mailgun.com/docs/mailgun/sdk/php_sdk

Command to install Composer, the PHP package manager, if not already installed.

```bash
curl -sS https://getcomposer.org/installer | php
```

--------------------------------

### Get mailing lists by page - response body

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-pages

Example response body for the 'Get mailing lists by page' endpoint. Contains paging links and an array of mailing list items.

```json
{
  "paging": {
    "first": "https://url_to_first_page",
    "last": "https://url_to_last_page",
    "next": "https://url_to_next_page",
    "previous": "https://url_to_previous_page"
  },
  "items": [
    { … },
    { … }
  ]
}
```

--------------------------------

### POST /v3/ip_warmups/{addr} - Create IP Warmup Plan

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/ip-address-warmup/post-v3-ip-warmups--addr-

Creates a new warmup plan for a dedicated IP address owned by the account. The IP address is specified in the path parameter {addr}. Uses basic authentication.

```curl
curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/ip_warmups/{addr}'
```

--------------------------------

### 200 Response for Get SNDS Address Info

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/microsoft-snds

Example 200 response body for the Get SNDS Address Info request. Contains a summary array of SNDSData objects and a total count.

```json
{
  "summary": [
    { … }
  ],
  "total": 1
}
```

--------------------------------

### List domain keys - 200 response example

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/domain-keys/post-v1-dkim-keys

Example JSON response for a successful list request. Shows the items array and paging object with previous, first, next, and last URLs for pagination.

```json
{
  "items": [
    { … },
    { … }
  ],
  "paging": {
    "previous": "/v1/dkim/keys?page=<previous_page_token>",
    "first": "/v1/dkim/keys",
    "next": "/v1/dkim/keys?page=<encoded_page_token>",
    "last": "/v1/dkim/keys?page=<last_page_token>"
  }
}
```

--------------------------------

### Create seed list with curl

Source: https://documentation.mailgun.com/docs/inboxready/inbox-placement-ir

Example curl command to create a seed list. Replace <YOUR_API_KEY> with your API key.

```bash
curl -X POST https://api.mailgun.net/v4/inbox/seedlists \
  -F 'name=list' \
  --user 'api:<YOUR_API_KEY>'
```

--------------------------------

### 200 Response JSON for Get GPT Domain

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains--domain-

Example 200 response body for the GET request. The response includes the domain and an array of data objects, with a total count field (not shown here).

```json
{
  "domain": "test.com",
  "data": [
    { … }
  ]
}
```

--------------------------------

### 200 response body example

Source: https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags/get-v3--domain--tag-stats

Example 200 response body for the tag stats endpoint. Shows the tag name, description, start and end dates, resolution, and an array of stats items.

```json
{
  "tag": "tag1",
  "description": "Optional Description",
  "start": "Tue, 14 Feb 2012 00:00:00 UTC",
  "end": "Fri, 01 Apr 2012 00:00:00 UTC",
  "resolution": "month",
  "stats": [
    { … }
  ]
}
```

--------------------------------

### Install Mailgun SDK with make

Source: https://documentation.mailgun.com/docs/mailgun/sdk/python_sdk

Installs the Mailgun SDK locally using conda and make on Unix platforms.

```bash
make install
```

--------------------------------

### Create Export Job for Email Preview Test Screenshots

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inspect/email-preview/post-v2-preview-tests--test-id--exports

Initiates an export job for Email Preview Test screenshots. Requires basic authentication and a valid test_id. The request body must include a list of client IDs. The response contains a job_id for monitoring.

```bash
curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v2/preview/tests/{test_id}/exports' \
  -H 'Content-Type: application/json' \
  -d '{
    "clients": [
      "android11_gmailapp_pixel5_dm",
      "android12_gmailapp_pixel6_dm"
    ]
  }'
```

--------------------------------

### 200 response body

Source: https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/dynamic-ip-pools/post-v3-domains-all-dynamic-pools-enroll

Example 200 response body indicating the asynchronous background job has started.

```json
{
  "message": "started"
}
```
Tokens:
Raw