Create Export Job for Email Preview Test Screenshots

Request

Initiates an export job that collects screenshots for a specified Email Preview Test. Provide the list of client IDs whose screenshots you want to export. The job status can be monitored using the job ID returned in the response.

Security

basicAuth

Path

test_idstringrequired

Unique identifier of the Email Preview Test to export screenshots for

Bodyapplication/jsonrequired

clientsArray of stringsrequired

test_idstringrequired

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"
    ]
  }'

Responses

A 200 response

Bodyapplication/json

job_idstringrequired

test_idstringrequired

clientsArray of stringsrequired

job_statusstringrequired

zip_urlstring

failed_clientsArray of strings

errorgithub.com-mailgun-emailpreview-queue_tracking-APIError (object) or null

Any of:

Response

{
  "job_id": "67b469d74b911fa30a4d782e",
  "test_id": "98b469d74b956fa30a4d125f",
  "clients": [
    "android11_gmailapp_pixel5_dm",
    "android12_gmailapp_pixel6_dm"
  ],
  "job_status": "Processing"
}