List Health Preview

Get List Health Preview Job

A single list health preview job by ID.

SecuritybasicAuth

Request

path Parameters

list_id

required

string

The list health preview 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>
	object
reason	string

default

A default response

get/v4/address/validate/preview/{list_id}

Request samples

Response samples

200
default

application/json

{"id": "SampleList",
"valid": true,
"status": "preview_complete",
"quantity": 1,
"created_at": 1234567890,
"summary": {"result": {"deliverable": 100,
"do_not_send": 0,
"undeliverable": 0,
"unknown": 0
},
"risk": {"high": 0,
"low": 100,
"medium": 0,
"unknown": 0
}
}
}

Promote List Health Preview Job

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

SecuritybasicAuth

Request

path Parameters

list_id

required

string

The list health preview job id

Responses

202

A 202 response

default

A default response

put/v4/address/validate/preview/{list_id}

Request samples

Response samples

202
default

application/json

{"Response": {"id": "example_list_id",
"message": "The bulk preview job was promoted to a bulk validation job."
},
"Status": 202
}

Create a List Health Preview Job

Start a list health 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 list health preview job id

Responses

202

A 202 response

default

A default response

post/v4/address/validate/preview/{list_id}

Request samples

Response samples

202
default

application/json

{"id": "example_list_id",
"message": "The validation preview was submitted."
}

Delete List Health Preview Job

Deletes a single list health previewk job by ID.

SecuritybasicAuth

Request

path Parameters

list_id

required

string

The list health preview job id

Responses

202

A 202 response

default

A default response

delete/v4/address/validate/preview/{list_id}

Request samples

Response samples

202
default

application/json

{"id": "example_list_id",
"message": "The bulk preview was deleted."
}

List List Health Preview Jobs

All list health 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>
	object
reason	string

default

A default response

get/v4/address/validate/preview

Request samples

Response samples

200
default

application/json

{"previews": [{"id": "SampleList",
"valid": true,
"status": "preview_complete",
"quantity": 1,
"created_at": 1234567890,
"summary": {"result": {"deliverable": 100,
"do_not_send": 0,
"undeliverable": 0,
"unknown": 0
},
"risk": {"high": 0,
"low": 100,
"medium": 0,
"unknown": 0
}
}
}
]
}