Create a batch verification request.
curl --request POST \
--url https://api.bounceless.io/v1/requests \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"emails": [
"jsmith@example.com"
],
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "<string>",
"state": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"partial": true,
"finalized": true,
"countsMayChange": true,
"errorCode": "<string>",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"finalization": {}
},
"counters": {},
"requestId": "<string>",
"replayed": true
}{
"request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "<string>",
"state": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"partial": true,
"finalized": true,
"countsMayChange": true,
"errorCode": "<string>",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"finalization": {}
},
"counters": {},
"requestId": "<string>",
"replayed": true
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}API reference
Create a batch
Submit a batch verification request.
POST
/
v1
/
requests
Create a batch verification request.
curl --request POST \
--url https://api.bounceless.io/v1/requests \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"emails": [
"jsmith@example.com"
],
"listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "<string>",
"state": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"partial": true,
"finalized": true,
"countsMayChange": true,
"errorCode": "<string>",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"finalization": {}
},
"counters": {},
"requestId": "<string>",
"replayed": true
}{
"request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "<string>",
"state": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"partial": true,
"finalized": true,
"countsMayChange": true,
"errorCode": "<string>",
"retentionExpiresAt": "2023-11-07T05:31:56Z",
"finalization": {}
},
"counters": {},
"requestId": "<string>",
"replayed": true
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}Use a stable
Idempotency-Key for an identical submission. Creation returns 202; a replay returns 200 with the same request ID.
Capture request.id, then pass it to the status and results routes. A batch accepts up to 10,000 addresses.Authorizations
apiKeybearerAuth
Canonical authentication. Send a Bounceless key in blc.… format.
Headers
Minimum string length:
1Body
application/json