Skip to content
Mailgun Validate/API Documentation/
/
Delete List Health Previe...

Validations Service (1.0.0)

Mailgun Email Validation service with RESTful JSON HTTP API for performing email validation. This service also manages list and CSV ingestion used in bulk validation processing.

Download OpenAPI description
openapi-validate-final.json
openapi-validate-final.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

https://api.eu.mailgun.net/

Validations

This API provides functionality to validate single addresses, and managing thresholds.

Operations

Bulk Validations

This API provides functionality to upload and manage bulk validation lists and previews.

Operations

List Health Preview

Operations

Create a List Health Preview Job

Request

Start a list health preview job from a list of addresses. We will sample the list and run validations on a small percentage.

Security
basicAuth
Path
list_idstringrequired

The list health preview job id

curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v4/address/validate/preview/{list_id}'

Responses

A 202 response

Bodyapplication/json
idstringrequired
messagestringrequired
Response
application/json
{
  "id": "example_list_id",
  "message": "The validation preview was submitted."
}

Delete List Health Preview Job

Request

Deletes a single list health previewk job by ID.

Security
basicAuth
Path
list_idstringrequired

The list health preview job id

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v4/address/validate/preview/{list_id}'

Responses

A 202 response

Bodyapplication/json
idstringrequired
messagestringrequired
Response
application/json
{
  "id": "example_list_id",
  "message": "The bulk preview was deleted."
}

List List Health Preview Jobs

Request

All list health preview jobs you have started.

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.mailgun.net/v4/address/validate/preview

Responses

A 200 response

Bodyapplication/json
previewsArray of objects(github.com-mailgun-validations-models-Preview)required
previews[].​idstringrequired
previews[].​validbooleanrequired
previews[].​statusstringrequired
previews[].​quantityinteger(int32)required
previews[].​created_atinteger(int64)required
previews[].​summaryobject
previews[].​reasonstring
Response
application/json
{
  "previews": [
    { … }
  ]
}