Verify multiple email addresses

Overview

Verify a list of email addresses.

K = the number of email addresses you are verifying

This operation will initially mark K credit(s) as pending. If the email address(es) cannot be validated and marked as unknown ("result": "unknown") by our system, the credit(s) will be reimbursed. Otherwise, if the email address(es) are marked either as valid, invalid or catch-all, the credit(s) will be deducted.

This feature can be integrated with your systems to provide bulk email validation.

Request body

The request body needs to have a property called emails, which is an array of objects.

Each object of this array must have at least one property called email (string).

You can pass in any other properties in this object. For example, you can pass in an extra id, if this is convenient for you. The other properties you are passing in this object can be of any type.

Fields

Field Type Description
emails array Array of objects with email addresses to be verified

Example Request #1

Here is a raw and valid example of this request.

# POST 'http://api.removebounce.com/v1/verify/bulk'

curl --location --request POST 'https://api.removebounce.com/v1/verify/bulk' \
     --header 'X-RB-API-KEY: <YOUR_API_KEY_HERE>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "emails": [
            {
                "email": "name@domain.com"
            },
            {
                "email": "name2@domain.com",
            },
            {
                "email": "name3@domain.com",
            }
        ]
    }'

Example Request #2

Here you can notice the extra property name in all of the objects from the emails array.

# POST 'http://api.removebounce.com/v1/verify/bulk'

curl --location --request POST 'https://api.removebounce.com/v1/verify/bulk' \
     --header 'X-RB-API-KEY: <YOUR_API_KEY_HERE>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "emails": [
            {
                "email": "name@domain.com",
                "name": "Jon Doe"
            },
            {
                "email": "name2@domain.com",
                "name": "Jane Doe"
            },
            {
                "email": "name3@domain.com",
                "name": "Jacky Doe"
            }
        ]
    }'

Example Request #3

Here you can notice the extra properties name and myApplicationId in all of the objects from the emails array.

These offer you the flexibility to populate these objects as you best see fit. All we require is one property email per object for the payload to be valid.

# POST 'http://api.removebounce.com/v1/verify/bulk'

curl --location --request POST 'https://api.removebounce.com/v1/verify/bulk' \
     --header 'X-RB-API-KEY: <YOUR_API_KEY_HERE>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "emails": [
            {
                "email": "name@domain.com",
                "name": "Jon Doe",
                "myApplicationId": "mock-id-123"
            },
            {
                "email": "name2@domain.com",
                "name": "Jane Doe",
                "myApplicationId": "mock-id-234"
            },
            {
                "email": "name3@domain.com",
                "name": "Jacky Doe",
                "myApplicationId": "mock-id-345"
            }
        ]
    }'

Example Request #4

Here you can notice a mixed variation of properties.

Again, all we require is one property email per object for the payload to be valid.

# POST 'http://api.removebounce.com/v1/verify/bulk'

curl --location --request POST 'https://api.removebounce.com/v1/verify/bulk' \
     --header 'X-RB-API-KEY: <YOUR_API_KEY_HERE>' \
     --header 'Content-Type: application/json' \
     --data-raw '{
        "emails": [
            {
                "email": "name@domain.com",
            },
            {
                "email": "name2@domain.com",
                "name": "Jane Doe",
            },
            {
                "email": "name3@domain.com",
                "myApplicationId": "mock-id-345"
            }
        ]
    }'

Example Response

Each successful request will receive a removeBounceId.

You can save this id for your records, as we will be providing this id in further events on the configured webhook subscriptions.

# Bulk Email object response example

{
  "removeBounceId": "5e9606db8a147f1652e0a45d"
}

Fields

Field Type Description
removeBounceId string RemoveBounce Id

Error codes

Code Type Message Reason
400 bad_request X-RB-API-KEY header is missing. Occurs due to the absence of the X-RB-API-KEY header from the request.
401 authentication_error No valid API key provided. Occurs due to providing an invalid API key. If you don't have a valid API key or if it expired, go to Dashboard and generate a new key.
400 bad_request Property emails is missing from the request body. Occurs due to the absence of emails property from the body.
400 bad_request Property emails is empty. Occurs due to passing an empty array of emails
400 bad_request Property email is missing from one of the emails. Occurs due to the absence of the required email property from each object inside the emails array.
5xx N/A N/A Occurs when the API is down.
Last Updated: 4/20/2020, 6:50:46 PM