Bulk Validations

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

Get Job V4

Gets a selected job by list ID.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The list ID being verified

header Parameters
X-Mailgun-Account-Id
required
string

Mailgun Account ID

Responses
200

A 200 response

Response Schema: application/json
created_at
required
integer <int32>
id
required
string
quantity
required
integer <int32>
records_processed
required
integer <int32>
reason
string
object
status
string
object
404

A 404 response

500

A 500 response

get/v4/address/validate/bulk/{list_id}
Request samples
Response samples
application/json
{}

Delete Job V4

Cancels a selected job by list ID.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The list ID being verified

header Parameters
X-Mailgun-Account-Id
required
string

Mailgun Account ID

Responses
200

A 200 response

Response Schema: application/json
property name*
additional property
object
404

A 404 response

409

A 409 response

500

A 500 response

delete/v4/address/validate/bulk/{list_id}
Request samples
Response samples
application/json
{
  • "message": "Validation job canceled."
}

Get Preview Job

A single preview job by ID.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The preview list id

Responses
200

A 200 response

Response Schema: application/json
id
required
string
valid
required
boolean
status
required
string
quantity
required
integer <int32>
created_at
required
integer <int64>
-
required
integer <int32>
object
reason
string
default

A default response

get/v4/address/validate/preview/{list_id}
Request samples
Response samples
application/json
{
  • "status": "preview_complete",
  • "quantity": 1,
  • "valid": true,
  • "created_at": 1234567890,
  • "id": "SampleList",
  • "summary": {
    • "result": {
      },
    • "risk": {
      }
    }
}

Promote Preview Job

A currently running preview job can be promoted to a full bulkvalidations job, which will validate all addresses in the list.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The bulk job list id

Responses
202

A 202 response

default

A default response

put/v4/address/validate/preview/{list_id}
Request samples
Response samples
application/json
{
  • "Status": 202,
  • "Response": {
    • "message": "The bulk preview job was promoted to a bulk validation job.",
    • "id": "example_list_id"
    }
}

Create Preview Job

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

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The bulk job list id

Responses
202

A 202 response

default

A default response

post/v4/address/validate/preview/{list_id}
Request samples
Response samples
application/json
{
  • "id": "example_list_id",
  • "message": "The validation preview was submitted."
}

Delete Preview Job

Deletes a single preview job by ID.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The bulk job list id

Responses
202

A 202 response

default

A default response

delete/v4/address/validate/preview/{list_id}
Request samples
Response samples
application/json
{
  • "id": "example_list_id",
  • "message": "The bulk preview was deleted."
}

List Preview Jobs

All preview jobs you have started.

SecuritybasicAuth
Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
Array
id
required
string
valid
required
boolean
status
required
string
quantity
required
integer <int32>
created_at
required
integer <int64>
-
required
integer <int32>
object
reason
string
default

A default response

get/v4/address/validate/preview
Request samples
Response samples
application/json
{
  • "previews": [
    • {
      }
    ]
}

List Jobs V4

Returns all jobs.

SecuritybasicAuth
Request
header Parameters
X-Mailgun-Account-Id
required
string

Mailgun Account ID

Responses
200

A 200 response

Response Schema: application/json
created_at
required
integer <int32>
id
required
string
quantity
required
integer <int32>
records_processed
required
integer <int32>
reason
string
object
status
string
object
404

A 404 response

500

A 500 response

get/v4/address/validate/bulk
Request samples
Response samples
application/json
{}

Get Job V3

Gets a selected job by list ID.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The list ID being verified

header Parameters
X-Mailgun-Account-Id
required
string

Mailgun Account ID

Responses
200

A 200 response

Response Schema: application/json
created_at
required
integer <int32>
id
required
string
quantity
required
integer <int32>
records_processed
required
integer <int32>
reason
string
object
status
string
object
404

A 404 response

500

A 500 response

get/v3/lists/{list_id}/validate
Request samples
Response samples
application/json
{}

Create Job V3

Starts a V3 list validation job.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The list ID being verified

header Parameters
X-Mailgun-Account-Id
required
string

Mailgun Account ID

Responses
200

A 200 response

Response Schema: application/json
property name*
additional property
object
400

A 400 response

post/v3/lists/{list_id}/validate
Request samples
Response samples
application/json
{
  • "message": "The validation job was submitted."
}

Delete Job V3

Cancels a selected job by list ID.

SecuritybasicAuth
Request
path Parameters
list_id
required
string

The list ID being verified

header Parameters
X-Mailgun-Account-Id
required
string

Mailgun Account ID

Responses
200

A 200 response

Response Schema: application/json
property name*
additional property
object
404

A 404 response

409

A 409 response

500

A 500 response

delete/v3/lists/{list_id}/validate
Request samples
Response samples
application/json
{
  • "message": "Validation job canceled."
}