Verify Mailing List

To send a mailing list for review, send a POST request to the URL: 

https://api.sendpulse.com/verifier-service/send-list-to-verify/

Request parameters:

id identifier of the mailing list to be verified

Sample request: 

{
   "id":89165888
}

Please note that you can not run several verifications on the same mailing list at the same time. You have to wait until the first verification ends. You can see the progress of the verification process using the Get Mailing List Verification Results.

If you are sending a mailing list for re-review, new addresses must be added to it. You can only verify a mailing list that has not been used in a campaign. Also pay attention to the expiration date of your current plan and the number of verifications you have available.

If the request is successful, the server will return the response:

{
    "result": true
}

To view the verification results, use the Get Mailing List Verify Result method.

 

Get Mailing List Verification Progress 

To see the progress of a mailing list that is currently being verified, send a GET request to the URL: 

https://api.sendpulse.com/verifier-service/get-progress/?id={id}

Request parameters: 

id identifier of the mailing list that is being verified

If the request is successful, the server will return an array with totals of how many email addresses have been verified out of the number you sent for verification: 

{
    "result": true,
    "data": {
        "total": 22,
        "processed": 20
    }
}

Get Mailing List Verification Results 

To get a list of email addresses from a mailing list with their verification results, send a GET request to the URL: 

https://api.sendpulse.com/verifier-service/check/?id={id} 

Request parameters:

id идентификатор книги, которую проверили

Please note that the methods should be used in pairs: first, you need to use the "Verify Mailing List" method, then "Get Mailing List Verification Results." Otherwise, you will receive a "false" error.

If the request is successful, the server will return a response:

{
    "id": 89163337,
    "address_book_name": "Mailing List 1",
    "all_emails_quantity": 5,
    "status": 1,
    "check_date": "2020-11-19 13:42:11",
    "data": {
        "0": 0, // number of unverified addresses (gray)
        "1": 5, // number of valid addresses (green)
        "2": 1, // number of unconfirmed addresses (yellow)
        "3": 0, // number of invalid addresses (red)

    },
    "is_updated": 0, // 1 - new addresses were added to the mailing list after checking, 0 - no verification was done for the mailing list
    "status_text": "Green", 
    "email_addresses": [
        {
            "id": 10417371353,
            "email_address": "example1@mail.ru",
            "check_date": "2020-11-19 13:41:20",
            "status": 1,
            "status_text": "Valid address"
        },
        {
            "id": 10417371352,
            "email_address": "example2@ukr.net",
            "check_date": "2020-11-19 13:41:23",
            "status": 1,
            "status_text": "Valid address"
        },
        {
            "id": 10417371349,
            "email_address": "example3@gmail.com",
            "check_date": "2020-11-19 13:41:20",
            "status": 1,
            "status_text": "Valid address"
        },
        {
            "id": 10417371347,
            "email_address": "example4@gmail.com",
            "check_date": "2020-11-19 13:41:21",
            "status": 1,
            "status_text": "Valid address"
        },
        {
            "id": 10417371345,
            "email_address": "example5@rambler.ru",
            "check_date": "2020-11-19 13:41:20",
            "status": 1,
            "status_text": "Valid address"
        }
    ],
    "email_addresses_total": 5
}

Possible address statuses: 

Code Description
0 Unverified address (the address was added after verification)
1 Valid address
2 Unconfirmed address 
3 Invalid address

Get a List of Verified Mailing Lists 

To get a list of verified mailing lists, send a GET request to the URL: 

https://api.sendpulse.com/verifier-service/check-list

Request parameters:

start from which record to display the result; default 0; optional parameter
count number of records; default 10; optional parameter

If the request is successful, the server will return a response:

{
    "total": 2, // number of verified mailing lists
    "list": [
        {
            "id": 89114118,
            "address_book_name": "Mailing list 1",
            "all_emails_quantity": 0,
            "status": 1, // 
            "check_date": "2020-11-23 14:28:14", 
            "data": {
       "0": 0, // number of unverified addresses (gray)
        "1": 21, // number of valid addresses (green)
        "2": 1, // number of unconfirmed addresses (yellow)
        "3": 0 // number of invalid addresses (red)

            },
            "is_updated": 0, // 1 - new addresses were added to the mailing list after checking, 0 - unverified mailing list
            "status_text": "Green",
            "is_garbage_in_book": false // true the mailing lists contains previously verified addresses, false there was no check for the mailing list
        },
        {
            "id": 89163340,
            "address_book_name": "Mailing list 2",
            "all_emails_quantity": 0,
            "status": 1,
            "check_date": "2020-11-19 13:43:11",
            "data": {
       "0": 0, // number of unverified addresses (gray)
        "1": 2, // number of valid addresses (green)
        "2": 1, // number of unconfirmed addresses (yellow)
        "3": 0 // number of invalid addresses (red)

            },
            "is_updated": 1, // 1 - new addresses were added to the mailing list after verification, 0 - unverified mailing list
            "status_text": "Green, updated",
            "is_garbage_in_book": true // true the mailing lists contains previously verified addresses, false there was no check for the mailing list
        }
    ]
}

Possible mailing list statuses: 

Code Name Description
1 Green The mailing list may contain a small percentage of invalid and unconfirmed addresses. In general, such a list is considered "good," since it will not cause many delivery errors.
2 Yellow The mailing list contains a small percentage of invalid addresses and a lot of unconfirmed addresses. 
3 Red The mailing list contains a high percentage of invalid addresses 

Delete Mailing List Verification Result 

To delete a mailing list verification result, send a POST request to the URL: 

https://api.sendpulse.com/verifier-service/delete-list-result

Request parameters:

id the identifier of the book for which you want to delete the verification result

Request example:

{
   "id":89165888
}

If the request is successful, the server will return a response:

{
    "result": true
}

Verify a Single Email Address

To verify one email address, send a POST request to the URL: 

https://api.sendpulse.com/verifier-service/send-single-to-verify/

Request parameters:

email the email address you need to verify

Request example:

{
   "email":"user@example.com"
}

If the request is successful, the server will return a response:

{
    "result": true
}

To view the verification result, use the Get Address Verification Result method. 

 

Get Address Verification Results 

To get the results of a verification, send a GET request to the URL: 

https://api.sendpulse.com/verifier-service/get-single-result/?email={email}

Request parameters:

email email address you verified

Please note that the methods should be used in pairs: first, you need to use the "Verify a Single Email Address" method, then "Get Address Verification Results." Otherwise, you will receive a false error.

If the request is successful, the server will return a response:

{
    "result": true,
    "data": {
        "email": "example1@gmail.com",
        "checks": {
            "status": 1,
            "valid_format": 1, // 1 if the address format is correct, that is, it contains valid characters in the correct order
            "disposable": 0, //1 if the address is provided by a disposable email service
            "webmail": 0, //1 if the address is provided by an email service
            "gibberish": 0, //1 if the address is generated automatically
            "status_text": "Valid address"
        }
}

Delete Address Verification Results

To delete the result of checking one address, send a POST request to the URL: 

https://api.sendpulse.com/verifier-service/delete-single-result

Request parameters:

email email address for which you want to delete the verification result

Request example:

{
   "email":"user@example.com"
}

If the request is successful, the server will return a response:

{
    "result": true
}

Create a Mailing List Verification Report 

To create a report with the verification results for a given mailing list, send a POST request to the URL: 

https://api.sendpulse.com/verifier-service/make-report

Request parameters:

id identifier of the mailing list you verified 
format report format, can take values 2 - csv, 3 - xls, 4 -xlsx; default 2; optional parameter 
status json_encoded array, addresses will have the following statuses in the report 0 - unverified, 1 - valid, 2 - unconfirmed, 3 - invalid; by default [1]; optional parameter
lang language of the report; optional parameter 

Request example:

{
   "id":89165888,
   "format":2,
   "status":"[1,2,3]",
   "lang":"ru"
}

If the request is successful, the server will return a response:

{
 "result": true
}

View a Mailing List Verification Report

To view a report with the results of a mailing list verification, send a GET request to the URL: 

https://api.sendpulse.com/verifier-service/check-report?id={id}

Request parameters:

id identifier of the mailing list for which you created a report
format report format, can take values 2 - csv, 3 - xls, 4 -xlsx; default 2; optional parameter

Please note that the methods should be used sequentially: first you need to use the "Create a Mailing List Verification Report " method, then "View a Mailing List Verification Report" and "Download Mailing List Verification Report." Otherwise, you will receive a false error.

If the request is successful, the server will return a response:

{
    "id": 89165888,
    "address_book_name": "Mailing list 1",
    "all_emails_quantity": 10,
    "status": 3,
    "check_date": "2020-11-23 18:02:36",
    "data": {
        "0": 0,
        "1": 3,
        "2": 0,
        "3": 1
    },
    "is_updated": 0, // // 1 - new addresses were added to the mailing list after verification, 0 - unverified mailing list
    "status_text": "Red",
    "email_addresses": [
        {
            "id": 10422192143,
            "email_address": "user@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 3,
            "status_text": "Invalid address"
        },
        {
            "id": 10422192131,
            "email_address": "user2@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 1,
            "status_text": "Valid address"
        },
        {
            "id": 10422192128,
            "email_address": "user3@example.com",
            "check_date": "2020-11-23 18:01:34",
            "status": 1,
            "status_text": "Valid address"
        },
        {
            "id": 10422192125,
            "email_address": "user4@example.com",
            "check_date": "2020-11-23 18:01:35",
            "status": 1,
            "status_text": "Valid address"
        }
    ],
    "email_addresses_total": 4
}

Download Mailing List Verification Report 

To download a report with the results of a mailing list verification, send a GET request to the URL: 

https://api.sendpulse.com/verifier-service/get-report?id={id}

Request parameters:

id identifier of the mailing list for which you created a report
format report format, can take values 2 - csv, 3 - xls, 4 -xlsx; default 2; optional parameter

If the request is successful, you will receive a list of addresses and the verification status of each in the selected format.

Please note that after downloading the report, it will be removed from the database. If you try to get the report again, you will receive a false response.