Skip to main content
ZeroBounce Docs logo
Log InSign Up Free
  • Home
  • Getting started
  • Products
  • API
  • Integrations
  • FAQ
  • About ZeroBounce
Browse documentation
ZeroBounce Docs logo
  • Getting started
  • Products
  • API
  • Integrations
  • FAQ
  • About ZeroBounce

Type at least 2 characters to search the docs.

↑↓ Navigate↵ OpenEsc Close

Docs Assistant

Answers written from the ZeroBounce documentation

Hi! I'm your ZeroBounce Docs Assistant. How can I help you with our APIs or integrations today?

Try Asking

Loading suggestions...

AI-generated from our docs. Check important details against the linked pages.

Integrations

  • ActiveCampaign Integration
  • Adobe Journey Integration
  • Adobe Marketo Integration
  • Amazon S3 Integration
  • Amazon S3 Bulk API
  • BigCommerce Integration
  • AWeber Integration
  • Clay.com Integration
  • Drip Integration
  • Customer.io Integration
  • Constant Contact Integration
  • Contact Form 7 Integration
  • Email Validator Browser Extension
  • Ghost Integration
  • CloudFlare Worker Integration
  • ChatGPT Integration
  • Claude
  • Google Sheets Integration
  • Gravity Forms Integration
  • Infinity Integration
  • Integrations Contacts Monitoring, Scheduling and Sharing
  • iPost Integration
  • HubSpot Integration
  • Iterable Integration
  • HubSpot Forms Integration
  • HubSpot Warmup Integration
  • JS Widget
  • Klaviyo Integration
  • Klaviyo Forms Integration
  • LinkedIn Integration
  • Mailchimp Integration
  • Microsoft Dynamics Integration
  • MailerLite Integration
  • monday.com Integration
  • Moosend Integration
  • Outreach Integration
  • PipeDrive Integration
  • Salesforce Integration v1.39
  • SFTP/FTP Integration
  • SFTP/FTP Bulk API
  • Unbounce Integration
  • Wix Integration
  • WordPress/WooCommerce Plugins
  • Zapier Integration
  • Zendesk Sell Integration
  • ZeroBounce MCP Server
  • Zoho Integration
  1. Home
  2. API Integrations
  3. SFTP/FTP Bulk API

Amazon S3 Bulk API - documentation

These endpoints provide the ability to validate, score and export files via SSH File Transfer Protocol (SFTP) or via File Transfer Protocol (FTP) depending on the settings configured on your ZeroBounce account.

Validate File via SFTP/FTP

In order to validate a file located on your machine via SFTP/FTP, you can use the following endpoint:

POST /validateSFTPfile

API URL: https://bulkapi.zerobounce.net/validateSFTPfile

Body Parameters:

  • Parameter
    Description
  • api_key
    Your API Key, found in your account. (Required)
  • file_name
    Your Input Bucket; in case it’s not provided here, we’ll use the one you provided in the UI Settings. (Optional)
  • 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 File via SFTP/FTP

In order to score a file located on your machine via SFTP/FTP, you can use the following endpoint:

POST /scoreSFTPfile

API URL: https://bulkapi.zerobounce.net/scoreSFTPfile

Body Parameters:

  • Parameter
    Description
  • api_key
    Your API Key, found in your account. (Required)
  • file_name
    The name of your file (e.g. my_file.txt). The path will be taken from the your User Settings. (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 via SFTP/FTP

In order to use Email Finder API with a file located on your machine via SFTP/FTP, you can use the following endpoint:

POST /emailFinderSFTPfile

API URL: https://bulkapi.zerobounce.net/emailFinderSFTPfile

Body Parameters:

  • Parameter
    Description
  • api_key
    Your API Key, found in your account. (Required)
  • file_name
    The name of your file (e.g. my_file.txt). The path will be taken from the your User Settings. (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 via SFTP/FTP

In order to use Domain Search API with a file located on your machine via SFTP/FTP, you can use the following endpoint:

POST /domainSearchSFTPfile

API URL: https://bulkapi.zerobounce.net/domainSearchSFTPfile

Body Parameters:

  • Parameter
    Description
  • api_key
    Your API Key, found in your account. (Required)
  • file_name
    The name of your file (e.g. my_file.txt). The path will be taken from the your User Settings. (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 File via SFTP/FTP

This endpoint needs to be called in order to export a file back to your machine, via SFTP/FTP. In case the Export Path is provided, we 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 /exportSFTPfile

API URL: https://bulkapi.zerobounce.net/exportSFTPfile

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_path
    The Export Path; in case it’s not provided here, we’ll use the one you provided in the UI Settings. (Optional)

ENDPOINT RESPONSE

Successful Response

Error Response

Was this page helpful?

PreviousSFTP/FTP IntegrationNextUnbounce Integration
Interested in our partner programs?
Partner program

Interested in our partner programs?