The /listS3files API returns the complete list of files that can be validated or scored from the provided Amazon S3 Bucket. Each entry will contain: the name of the file, its size and the date when it was lastly modified.
Error Response
Validate Amazon S3 File
In order to validate a file from Amazon S3, you can use the following endpoint:
POST /validateS3file
API URL: https://bulkapi.zerobounce.net/validateS3file
Body Parameters:
Parameter
Description
api_key
Your API Key, found in your account. (Required)
file_name
The full path of the file from your Amazon S3 Bucket, as provided by the /listS3files. (Required)
has_header_row
True if the first row of your submitted file is a header row, else false. (Required)
remove_duplicates
True if you want the system to remove duplicate emails, else false (defaults to true). Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), the system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified. (Optional)
return_url
The URL will be used to call back when the validation is completed. (Optional)
ENDPOINT RESPONSE
Successful Response
Error Response
Score Amazon S3 File
In order to score a file from Amazon S3 Bucket, you can use the following endpoint:
POST /scoreS3file
API URL: https://bulkapi.zerobounce.net/scoreS3file
Body Parameters:
Parameter
Description
api_key
Your API Key, found in your account. (Required)
file_name
The full path of the file from your Amazon S3 Bucket, as provided by the /listS3files. (Required)
has_header_row
True if the first row of your submitted file is a header row, else false. (Required)
remove_duplicates
True if you want the system to remove duplicate emails, else false (defaults to true). Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), the system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified. (Optional)
return_url
The URL will be used to call back when the validation is completed. (Optional)
ENDPOINT RESPONSE
Successful Response
Error Response
Email Finderⓘ for Amazon S3 File
In order to use the Email Finderⓘ API on a file from Amazon S3, you can use the following endpoint:
POST /emailFinderS3file
API URL: https://bulkapi.zerobounce.net/emailFinderS3file
Body Parameters:
Parameter
Description
api_key
Your API Key, found in your account. (Required)
file_name
The full path of the file from your Amazon S3 Bucket, as provided by the /listS3files. (Required)
has_header_row
True if the first row of your submitted file is a header row, else false. (Required)
remove_duplicates
True if you want the system to remove duplicate emails, else false (defaults to true). Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), the system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified. (Optional)
return_url
The URL will be used to call back when the validation is completed. (Optional)
ENDPOINT RESPONSE
Successful Response
Error Response
Domain Search Amazon S3 File
In order to use the Domain Search API on a file from Amazon S3, you can use the following endpoint:
POST /domainSearchS3file
API URL: https://bulkapi.zerobounce.net/domainSearchS3file
Body Parameters:
Parameter
Description
api_key
Your API Key, found in your account. (Required)
file_name
The full path of the file from your Amazon S3 Bucket, as provided by the /listS3files. (Required)
has_header_row
True if the first row of your submitted file is a header row, else false. (Required)
remove_duplicates
True if you want the system to remove duplicate emails, else false (defaults to true). Please note that if we remove more than 50% of the lines because of duplicates (parameter is true), the system will return a 400 bad request error as a safety net to let you know that more than 50% of the file has been modified. (Optional)
return_url
The URL will be used to call back when the validation is completed. (Optional)
ENDPOINT RESPONSE
Successful Response
Error Response
Export Amazon S3 File
This endpoint needs to be called in order to export a file back to Amazon S3 Bucket. In case the Export Bucket is provided, will overwrite the one saved in our Database. Otherwise, we’ll use the one in your Settings. To be mentioned that it works for both validated and scored files.
POST /exportS3file
API URL: https://bulkapi.zerobounce.net/exportS3file
Body Parameters:
Parameter
Description
api_key
Your API Key, found in your account. (Required)
file_id
The ID of the validated/scored file. (Required)
export_bucket
Your Export Bucket; in case it’s not provided here, we’ll use the one you provided in the UI Settings. (Optional)
