Check the status of a list

Overview

Check the status of a list uploaded through API. Once you upload a list using RemoveBounce API, specifying the removeBounceId, you can check the statistics of the list in progress.

Example Request

Here is a raw and valid example of this request.

# GET 'http://api.removebounce.com/v1/list/:removeBounceId/status'

curl --location --request GET 'http://api.removebounce.com/v1/list/:removeBounceId/status' \
     --header 'X-RB-API-KEY: <YOUR_API_KEY_HERE>'

Example Response

# List cleaning with status IN_PROGRESS response example

{
    "removeBounceId": "1111a2222b3333c4444d",
    "percentageComplete": 75,
    "statistics": {
        "validCount": 1,
        "invalidCount": 1,
        "unknownCount": 1,
        "catchAllCount": 0,
        "totalCount": 4
    },
    "status": "IN_PROGRESS"
}

# List cleaning with status COMPLETED response example

{
    "removeBounceId": "1111a2222b3333c4444d",
    "percentageComplete": 100,
    "statistics": {
        "validCount": 1,
        "invalidCount": 1,
        "unknownCount": 1,
        "catchAllCount": 1,
        "totalCount": 4
    },
    "emails": [
        {
            "email": "name1@domain.com",
            "name": "Jon Doe",
            "status": "valid"
        },
        {
            "email": "name2@domain.com",
            "name": "Jon Doe",
            "status": "invalid"
        },
        {
            "email": "name3@domain.com",
            "name": "Jon Doe",
            "status": "unknown"
        },
        {
            "email": "name4@domain.com",
            "name": "Jon Doe",
            "status": "catch_all"
        }
    ],
    "status": "COMPLETED"
}

Fields

Field	Type	Description
removeBounceId	string	RemoveBounce Id
percentageComplete	number	The percentage of the list that has been cleaned
statistics	Object	Statistics about already cleaned emails. Includes: validCount, invalidCount, unknownCount, catchAllCount, totalCount
emails	Array	Array of the uploaded emails with the status of each email.
status	string	Status of the list: IN_PROGRESS / COMPLETED

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.
404	not_found	Invalid removeBounceId provided in the request.	Occurs due to providing an incorrect removeBounceId.
5xx	N/A	N/A	Occurs when the API is down.