Upload a bulk email list

This endpoint allows you to upload a bulk email validation list. It accepts the email data in multiple ways. You can upload email addresses in the CSV file format or an array of objects.
If auto_verify is enabled, this API will create a job and automatically process each email in the uploaded list. If the auto_verify is disabled, the email list is prepared and ‘ready’ for verification, you can start verification using start endpoint. The API response does not contain the verification results. Instead it returns the job_id in the success response. Once the verification is completed, you can download the result using this job_id.

Option 1: CSV file

This endpoint accepts the file in .csv (comma separated values) format. The supported size of the file is 10Mb. The number of emails in a file must be within 5 lakhs. The additional columns in the csv file will be retained.

Option 2: Array of emails

Instead of having to write to a file, you can dynamically create email lists on the fly when you provide the data directly. The array of objects contains the ‘email’ field as well as any additional data you want to include with the email. If the data is provided as an object, the key names will be used for the column headers. Here is an example of an email object in JSON format.

Emails Object

{
    "auto_verify": "true",
    "emails": [
        {
            "email": "[email protected]",
            "firstname": "John",
            "lastname": "Doe"
        },
        {
            "email": "[email protected]",
          	"firstname": "Daniel",
            "lastname": "Jay"
        }
    ]
}

Successful Response

JSON

HTTP/1.1 200 OK
{
   "job_id": "r374aki32rnatv868nntpxloc7dkilszc3eu",
   "success": true,   
   "message": "Bulk email verification list has been created"
}

Response Parameters

Parameter	Type	Description
job_id	[string]	The job_id corresponding to the list you have been created
success	[true, false]	Whether the API request call was successful or not.
message	[string]	Describes API result

Other responses

The response you get when the API key is invalid:

JSON

HTTP/1.1 401 Unauthorized
{   
   "result":"Invalid API Key",
   "success": false
}

The response you get when the auto_verify is enabled:

JSON

HTTP/1.1 200 OK
{
   "job_id": "r374aki32rnatv868nntpxloc7dkilszc3eu",
   "success": true,   
   "message": "Bulk email verification list has been created and starts verification shortly"
}

The response you get when you provide the incorrect file format:

JSON

HTTP/1.1 400 BadRequest
{
   "result": "Invalid file data",
   "success": false
}