### AI Scoring: Get File Source: https://context7.com/zerobounce/postman-v2/llms.txt Downloads the AI scoring results file for a completed scoring job. ```APIDOC ## AI Scoring: Get File ### Description Downloads the AI scoring results file for a completed scoring job. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/v2/scoring/getfile ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The unique identifier for the scoring job. ### Request Example ```bash curl -X GET "https://bulkapi.zerobounce.net/v2/scoring/getfile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \ -o scoring_results.csv ``` ### Response #### Success Response (200) - The response is a CSV file containing the AI scoring results. ``` -------------------------------- ### Bulk Email Finder: Get File Source: https://context7.com/zerobounce/postman-v2/llms.txt Downloads the results of a bulk email finder job. ```APIDOC ## Bulk Email Finder: Get File ### Description Downloads the results of a bulk email finder job. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/email-finder/getfile ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The ID of the file to download. ``` -------------------------------- ### GET /getcredits Source: https://context7.com/zerobounce/postman-v2/llms.txt Retrieves the current credit balance available in your ZeroBounce account. ```APIDOC ## GET /getcredits ### Description Retrieves the current credit balance available in your ZeroBounce account. ### Method GET ### Endpoint https://api.zerobounce.net/v2/getcredits ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key ### Response #### Success Response (200) - **Credits** (string) - Current credit balance #### Response Example { "Credits": "2375323" } ``` -------------------------------- ### Retrieve List Evaluation Results Source: https://context7.com/zerobounce/postman-v2/llms.txt Get the evaluation results for a previously submitted list. Requires your API key and the file ID. ```bash # Get list evaluation results (replace with actual file ID) curl -X GET "https://bulkapi.zerobounce.net/v2/listevaluator/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/?api_key=YOUR_API_KEY" ``` -------------------------------- ### GET /validate Source: https://context7.com/zerobounce/postman-v2/llms.txt Validates a single email address in real-time. ```APIDOC ## GET /validate ### Description Validates a single email address in real-time, returning detailed information about the email's validity, status, and associated metadata. ### Method GET ### Endpoint https://api.zerobounce.net/v2/validate ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key - **email** (string) - Required - The email address to validate - **ip_address** (string) - Optional - IP address for tracking - **activity_data** (boolean) - Optional - Include activity data - **verify_plus** (boolean) - Optional - Enable Verify+ validation - **timeout** (integer) - Optional - Request timeout in seconds ### Response #### Success Response (200) - **address** (string) - Validated email address - **status** (string) - Validation status - **domain** (string) - Domain of the email #### Response Example { "address": "valid@example.com", "status": "valid", "domain": "example.com" } ``` -------------------------------- ### Bulk Domain Search: File Status, Get File, Delete File Source: https://context7.com/zerobounce/postman-v2/llms.txt Manage domain search jobs with the same pattern as other bulk operations. ```APIDOC ## Bulk Domain Search: File Status ### Description Checks the status of a bulk domain search job. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/domain-search/filestatus ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The ID of the file to check the status for. ## Bulk Domain Search: Get File ### Description Downloads the results of a bulk domain search job. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/domain-search/getfile ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The ID of the file to download. ## Bulk Domain Search: Delete File ### Description Removes a bulk domain search file from ZeroBounce servers. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/domain-search/deletefile ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The ID of the file to delete. ``` -------------------------------- ### List Evaluator: Get Evaluated File Source: https://context7.com/zerobounce/postman-v2/llms.txt Retrieves the evaluation results for a submitted file. ```APIDOC ## List Evaluator: Get Evaluated File ### Description Retrieves the evaluation results for a submitted file. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/v2/listevaluator/{file_id}/ ### Path Parameters - **file_id** (string) - Required - The ID of the evaluated file. ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. ``` -------------------------------- ### GET /getapiusage Source: https://context7.com/zerobounce/postman-v2/llms.txt Returns detailed API usage statistics for a specified date range. ```APIDOC ## GET /getapiusage ### Description Returns detailed API usage statistics for a specified date range, including validation counts broken down by result type. ### Method GET ### Endpoint https://api.zerobounce.net/v2/getapiusage ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key - **start_date** (string) - Required - Start date in YYYY-MM-DD format - **end_date** (string) - Required - End date in YYYY-MM-DD format ### Response #### Success Response (200) - **total** (integer) - Total validations - **status_valid** (integer) - Count of valid emails - **status_invalid** (integer) - Count of invalid emails - **status_catch_all** (integer) - Count of catch-all emails - **status_unknown** (integer) - Count of unknown emails - **start_date** (string) - Start date - **end_date** (string) - End date #### Response Example { "total": 10000, "status_valid": 8500, "status_invalid": 1200, "status_catch_all": 200, "status_unknown": 100, "start_date": "2024-01-01", "end_date": "2024-01-31" } ``` -------------------------------- ### Get Activity Data for Email Source: https://context7.com/zerobounce/postman-v2/llms.txt Retrieves activity information for an email address, indicating how recently the email has been active or engaged. This helps identify dormant or inactive email addresses. Requires an email address and API key. ```bash # Get activity data for an email curl -X GET "https://api.zerobounce.net/v2/activity?api_key=YOUR_API_KEY&email=user@example.com" ``` -------------------------------- ### Bulk Email Validation: Get File Source: https://context7.com/zerobounce/postman-v2/llms.txt Downloads the validation results file for a completed bulk validation job. The response contains the validated data in CSV format. ```APIDOC ## Bulk Email Validation: Get File ### Description Downloads the validation results file for a completed bulk validation job. The response contains the validated data in CSV format. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/v2/getfile ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The unique identifier for the file to download. - **activity_data** (boolean) - Optional - If true, includes activity data in the results. ### Request Example ```bash curl -X GET "https://bulkapi.zerobounce.net/v2/getfile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee&activity_data=true" \ -o validated_results.csv ``` ### Response #### Success Response (200) - The response is a CSV file containing the validation results. ``` -------------------------------- ### Get AI Score for Single Email Source: https://context7.com/zerobounce/postman-v2/llms.txt Uses artificial intelligence to score an email address based on its likelihood of engagement. Returns a score indicating the quality and activity level of the email. Requires an email address and API key. ```bash # Get AI score for a single email curl -X GET "https://api.zerobounce.net/v2/scoring?api_key=YOUR_API_KEY&email=user@example.com" ``` -------------------------------- ### Retrieve Account Credit Balance Source: https://context7.com/zerobounce/postman-v2/llms.txt Fetches the current number of credits available in the account. ```bash # Get your current credit balance curl -X GET "https://api.zerobounce.net/v2/getcredits?api_key=YOUR_API_KEY" ``` -------------------------------- ### Upload File for Bulk Email Finding Source: https://context7.com/zerobounce/postman-v2/llms.txt Uploads a file containing domains and names for bulk email finding. The API attempts to discover valid email addresses for each entry. Specify column mappings and header row presence. ```bash # Upload file for bulk email finding curl -X POST "https://bulkapi.zerobounce.net/email-finder/sendfile" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/prospects.csv" \ -F "domain_column=1" \ -F "first_name_column=2" \ -F "last_name_column=3" \ -F "has_header_row=true" ``` -------------------------------- ### Download AI Scoring Results File Source: https://context7.com/zerobounce/postman-v2/llms.txt Downloads the AI scoring results file for a completed scoring job. Requires the file_id to retrieve the results. ```bash # Download AI scoring results curl -X GET "https://bulkapi.zerobounce.net/v2/scoring/getfile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \ -o scoring_results.csv ``` -------------------------------- ### Upload File for Bulk Domain Search Source: https://context7.com/zerobounce/postman-v2/llms.txt Submit a CSV file containing domains to find associated email addresses. Specify the column containing domains and if a header row exists. Returns a file ID for tracking. ```bash # Upload file for domain search curl -X POST "https://bulkapi.zerobounce.net/domain-search/sendfile" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/domains.csv" \ -F "domain_column=1" \ -F "has_header_row=true" ``` -------------------------------- ### Submit Evaluated File for Validation Source: https://context7.com/zerobounce/postman-v2/llms.txt Send a file that has already been evaluated for full validation processing. Requires your API key and the evaluated file. ```bash # Send evaluated file for validation curl -X POST "https://bulkapi.zerobounce.net/v2/send-evaluated-file/" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/evaluated_emails.csv" ``` -------------------------------- ### Upload File for List Evaluation Source: https://context7.com/zerobounce/postman-v2/llms.txt Submit a CSV file for list evaluation to assess email list quality without consuming validation credits. Specify the email address column. Returns a file ID. ```bash # Upload file for list evaluation curl -X POST "https://bulkapi.zerobounce.net/v2/listevaluator/" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/emails.csv" \ -F "email_address_column=1" ``` -------------------------------- ### Manage Bulk Domain Search Jobs Source: https://context7.com/zerobounce/postman-v2/llms.txt Endpoints for checking the status, downloading results, and deleting files for bulk domain search jobs. Use the provided file ID for operations. ```bash # Check domain search status curl -X GET "https://bulkapi.zerobounce.net/domain-search/filestatus?api_key=YOUR_API_KEY&file_id=FILE_ID" ``` ```bash # Download domain search results curl -X GET "https://bulkapi.zerobounce.net/domain-search/getfile?api_key=YOUR_API_KEY&file_id=FILE_ID" -o domain_results.csv ``` ```bash # Delete domain search file curl -X GET "https://bulkapi.zerobounce.net/domain-search/deletefile?api_key=YOUR_API_KEY&file_id=FILE_ID" ``` -------------------------------- ### Amazon S3 Integration: List Files Source: https://context7.com/zerobounce/postman-v2/llms.txt Lists available files in your connected Amazon S3 bucket for validation. ```APIDOC ## Amazon S3 Integration: List Files ### Description Lists available files in your connected Amazon S3 bucket for validation. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/listS3files ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **bucket** (string) - Required - The name of your S3 bucket. - **search** (string) - Optional - A search term to filter files. ``` -------------------------------- ### Bulk Domain Search: Send File Source: https://context7.com/zerobounce/postman-v2/llms.txt Uploads a file containing domains to search for associated email addresses. Returns all discoverable emails for each domain. ```APIDOC ## Bulk Domain Search: Send File ### Description Uploads a file containing domains to search for associated email addresses. Returns all discoverable emails for each domain. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/domain-search/sendfile ### Parameters #### Form Data - **api_key** (string) - Required - Your ZeroBounce API key. - **file** (file) - Required - The CSV file containing domains. - **domain_column** (integer) - Required - The column number containing the domains (1-based index). - **has_header_row** (boolean) - Optional - Set to true if the file has a header row. ``` -------------------------------- ### Upload Bulk Validation File Source: https://context7.com/zerobounce/postman-v2/llms.txt Uploads a CSV or TXT file for asynchronous bulk validation processing. ```bash # Upload a file for bulk email validation curl -X POST "https://bulkapi.zerobounce.net/v2/sendfile" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/emails.csv" \ -F "email_address_column=1" \ -F "has_header_row=true" \ -F "remove_duplicate=true" \ -F "return_url=https://yourwebsite.com/callback" ``` -------------------------------- ### Upload File for Bulk AI Scoring Source: https://context7.com/zerobounce/postman-v2/llms.txt Uploads a file for bulk AI scoring. Similar to bulk validation, this processes emails asynchronously and assigns quality scores to each address. Specify column mappings and header row presence. ```bash # Upload a file for AI scoring curl -X POST "https://bulkapi.zerobounce.net/v2/scoring/sendfile" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/emails.csv" \ -F "email_address_column=1" \ -F "has_header_row=true" \ -F "remove_duplicate=true" ``` -------------------------------- ### POST /scoreS3file Source: https://context7.com/zerobounce/postman-v2/llms.txt Initiates AI scoring for an email list file stored in an Amazon S3 bucket. ```APIDOC ## POST /scoreS3file ### Description Initiates AI scoring of a file directly from your S3 bucket. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/scoreS3file ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key - **file_name** (string) - Required - The path to the file in your S3 bucket - **has_header_row** (boolean) - Required - Whether the file contains a header row - **remove_duplicates** (boolean) - Required - Whether to remove duplicate emails ``` -------------------------------- ### Download Bulk Validation Results Source: https://context7.com/zerobounce/postman-v2/llms.txt Downloads the validation results file for a completed bulk validation job. The response contains the validated data in CSV format. Ensure you have the correct file_id. ```bash # Download the validated results file curl -X GET "https://bulkapi.zerobounce.net/v2/getfile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee&activity_data=true" \ -o validated_results.csv ``` -------------------------------- ### Find Email Format for Domain Source: https://context7.com/zerobounce/postman-v2/llms.txt Finds the most likely email format for a given domain. Useful for sales prospecting and lead generation. Requires a domain and API key. ```bash # Find email format for a domain curl -X GET "https://api.zerobounce.net/v2/guessformat?api_key=YOUR_API_KEY&domain=example.com" ``` -------------------------------- ### Bulk Email Finder: Send File Source: https://context7.com/zerobounce/postman-v2/llms.txt Uploads a file containing domains and names for bulk email finding. The API attempts to discover valid email addresses for each entry. ```APIDOC ## Bulk Email Finder: Send File ### Description Uploads a file containing domains and names for bulk email finding. The API attempts to discover valid email addresses for each entry. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/email-finder/sendfile ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key. - **file** (file) - Required - The CSV file containing domains and names. Use `@` prefix for file upload. - **domain_column** (integer) - Required - The column number (1-based) containing the domains. - **first_name_column** (integer) - Optional - The column number (1-based) containing the first names. - **last_name_column** (integer) - Optional - The column number (1-based) containing the last names. - **has_header_row** (boolean) - Optional - Set to true if the file has a header row. ### Request Example ```bash curl -X POST "https://bulkapi.zerobounce.net/email-finder/sendfile" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/prospects.csv" \ -F "domain_column=1" \ -F "first_name_column=2" \ -F "last_name_column=3" \ -F "has_header_row=true" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the file was accepted for processing. - **message** (string) - A message confirming the file acceptance. - **file_name** (string) - The name of the uploaded file. - **file_id** (string) - The unique identifier for the processing job. ``` -------------------------------- ### Download Bulk Email Finder Results Source: https://context7.com/zerobounce/postman-v2/llms.txt Retrieve the results of a completed bulk email finder job. The results will be saved to a CSV file. Requires your API key and the file ID. ```bash # Download email finder results curl -X GET "https://bulkapi.zerobounce.net/email-finder/getfile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \ -o found_emails.csv ``` -------------------------------- ### Bulk Email Finder: Delete File Source: https://context7.com/zerobounce/postman-v2/llms.txt Removes an email finder file from ZeroBounce servers. ```APIDOC ## Bulk Email Finder: Delete File ### Description Removes an email finder file from ZeroBounce servers. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/email-finder/deletefile ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The ID of the file to delete. ``` -------------------------------- ### List Amazon S3 Files for Validation Source: https://context7.com/zerobounce/postman-v2/llms.txt Retrieve a list of files available in your connected Amazon S3 bucket that can be used for validation. Requires your API key, bucket name, and an optional search term. ```bash # List S3 files curl -X GET "https://bulkapi.zerobounce.net/listS3files?api_key=YOUR_API_KEY&bucket=your-bucket-name&search=emails" ``` -------------------------------- ### Check Bulk Email Finder File Status Source: https://context7.com/zerobounce/postman-v2/llms.txt Use this endpoint to check the status of a submitted bulk email finder job. Requires your API key and the file ID. ```bash # Check email finder file status curl -X GET "https://bulkapi.zerobounce.net/email-finder/filestatus?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` -------------------------------- ### Score S3 File via cURL Source: https://context7.com/zerobounce/postman-v2/llms.txt Initiates AI scoring for a file stored in an S3 bucket. ```bash curl -X POST "https://bulkapi.zerobounce.net/scoreS3file" \ -F "api_key=YOUR_API_KEY" \ -F "file_name=emails/january_list.csv" \ -F "has_header_row=true" \ -F "remove_duplicates=true" ``` -------------------------------- ### Delete Bulk Email Finder File Source: https://context7.com/zerobounce/postman-v2/llms.txt Remove a processed email finder file from ZeroBounce servers to free up space. Requires your API key and the file ID. ```bash # Delete email finder file curl -X GET "https://bulkapi.zerobounce.net/email-finder/deletefile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` -------------------------------- ### Find Email for Specific Person Source: https://context7.com/zerobounce/postman-v2/llms.txt Finds a specific person's email address for a given domain, first name, and last name. Useful for sales prospecting and lead generation. Requires domain, first name, last name, and API key. ```bash # Find email for a specific person curl -X GET "https://api.zerobounce.net/v2/guessformat?api_key=YOUR_API_KEY&domain=example.com&first_name=John&last_name=Doe" ``` -------------------------------- ### AI Scoring: Send File Source: https://context7.com/zerobounce/postman-v2/llms.txt Uploads a file for bulk AI scoring. Similar to bulk validation, this processes emails asynchronously and assigns quality scores to each address. ```APIDOC ## AI Scoring: Send File ### Description Uploads a file for bulk AI scoring. Similar to bulk validation, this processes emails asynchronously and assigns quality scores to each address. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/v2/scoring/sendfile ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key. - **file** (file) - Required - The CSV file containing emails to score. Use `@` prefix for file upload. - **email_address_column** (integer) - Required - The column number (1-based) containing the email addresses. - **has_header_row** (boolean) - Optional - Set to true if the file has a header row. - **remove_duplicate** (boolean) - Optional - Set to true to remove duplicate email addresses before processing. ### Request Example ```bash curl -X POST "https://bulkapi.zerobounce.net/v2/scoring/sendfile" \ -F "api_key=YOUR_API_KEY" \ -F "file=@/path/to/emails.csv" \ -F "email_address_column=1" \ -F "has_header_row=true" \ -F "remove_duplicate=true" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the file was accepted for processing. - **message** (string) - A message confirming the file acceptance. - **file_name** (string) - The name of the uploaded file. - **file_id** (string) - The unique identifier for the processing job. #### Response Example ```json { "success": true, "message": "File Accepted", "file_name": "emails.csv", "file_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ``` ``` -------------------------------- ### Retrieve API Usage Statistics Source: https://context7.com/zerobounce/postman-v2/llms.txt Retrieves validation counts and status breakdowns for a specified date range. ```bash # Get API usage for a specific date range curl -X GET "https://api.zerobounce.net/v2/getapiusage?api_key=YOUR_API_KEY&start_date=2024-01-01&end_date=2024-01-31" ``` -------------------------------- ### Email Finder API (Single/Real-time) Source: https://context7.com/zerobounce/postman-v2/llms.txt Finds the most likely email format for a given domain and optionally validates a specific person's email. Useful for sales prospecting and lead generation. ```APIDOC ## Email Finder API (Single/Real-time) ### Description Finds the most likely email format for a given domain and optionally validates a specific person's email. Useful for sales prospecting and lead generation. ### Method GET ### Endpoint https://api.zerobounce.net/v2/guessformat ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **domain** (string) - Required - The domain to search for email formats. - **first_name** (string) - Optional - The first name of the person to find an email for. - **last_name** (string) - Optional - The last name of the person to find an email for. ### Request Example ```bash # Find email format for a domain curl -X GET "https://api.zerobounce.net/v2/guessformat?api_key=YOUR_API_KEY&domain=example.com" # Find email for a specific person curl -X GET "https://api.zerobounce.net/v2/guessformat?api_key=YOUR_API_KEY&domain=example.com&first_name=John&last_name=Doe" ``` ### Response #### Success Response (200) - **email** (string) - The found email address. - **domain** (string) - The domain queried. - **format** (string) - The email format (e.g., "first.last"). - **status** (string) - The status of the email (e.g., "valid"). - **confidence** (string) - The confidence level of the found email (e.g., "high"). #### Response Example ```json { "email": "john.doe@example.com", "domain": "example.com", "format": "first.last", "status": "valid", "confidence": "high" } ``` ``` -------------------------------- ### List Evaluator: Send File Source: https://context7.com/zerobounce/postman-v2/llms.txt Submits a file for list evaluation, which provides an assessment of your email list quality without consuming validation credits. Returns statistics about expected bounce rates and list health. ```APIDOC ## List Evaluator: Send File ### Description Submits a file for list evaluation, which provides an assessment of your email list quality without consuming validation credits. Returns statistics about expected bounce rates and list health. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/v2/listevaluator/ ### Parameters #### Form Data - **api_key** (string) - Required - Your ZeroBounce API key. - **file** (file) - Required - The CSV file containing email addresses. - **email_address_column** (integer) - Required - The column number containing the email addresses (1-based index). ``` -------------------------------- ### POST /validateS3file Source: https://context7.com/zerobounce/postman-v2/llms.txt Initiates the validation process for a file stored in an Amazon S3 bucket. ```APIDOC ## POST /validateS3file ### Description Initiates validation of a file directly from your S3 bucket. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/validateS3file ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key - **file_name** (string) - Required - The path to the file in your S3 bucket - **has_header_row** (boolean) - Required - Whether the file contains a header row - **remove_duplicates** (boolean) - Required - Whether to remove duplicate emails ### Response #### Success Response (200) - **success** (boolean) - Status of the request - **message** (string) - Confirmation message - **file_id** (string) - Unique identifier for the validation job #### Response Example { "success": true, "message": "File submitted for validation", "file_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ``` -------------------------------- ### Bulk Email Finder: File Status Source: https://context7.com/zerobounce/postman-v2/llms.txt Checks the status of a bulk email finder job. ```APIDOC ## Bulk Email Finder: File Status ### Description Checks the status of a bulk email finder job. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/email-finder/filestatus ### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The ID of the file to check the status for. ``` -------------------------------- ### POST /validatebatch Source: https://context7.com/zerobounce/postman-v2/llms.txt Validates multiple email addresses in a single API request. ```APIDOC ## POST /validatebatch ### Description Validates multiple email addresses in a single API request. Accepts a JSON payload with up to 100 emails. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/v2/validatebatch ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key - **email_batch** (array) - Required - List of objects containing email_address and optional ip_address - **activity_data** (boolean) - Optional - Include activity data - **verify_plus** (boolean) - Optional - Enable Verify+ validation ### Response #### Success Response (200) - **email_batch** (array) - List of validation results #### Response Example { "email_batch": [ {"address": "valid@example.com", "status": "valid"} ] } ``` -------------------------------- ### Add Allow/Block Filter Rule Source: https://context7.com/zerobounce/postman-v2/llms.txt Create or update custom filtering rules to always allow or block specific emails, domains, or MX records during validation. Requires API key, rule type, target, and value. ```bash # Add an allow rule for a domain curl -X POST "https://api.zerobounce.net/v2/filters/add" \ -d "api_key=YOUR_API_KEY" \ -d "rule=allow" \ -d "target=domain" \ -d "value=trusted-company.com" ``` ```bash # Add a block rule for an email curl -X POST "https://api.zerobounce.net/v2/filters/add" \ -d "api_key=YOUR_API_KEY" \ -d "rule=block" \ -d "target=email" \ -d "value=spam@example.com" ``` ```bash # Add a block rule for an MX record curl -X POST "https://api.zerobounce.net/v2/filters/add" \ -d "api_key=YOUR_API_KEY" \ -d "rule=block" \ -d "target=mx" \ -d "value=mail.suspicious-server.com" ``` -------------------------------- ### POST /exportS3file Source: https://context7.com/zerobounce/postman-v2/llms.txt Exports the results of a validation or scoring job back to a specified Amazon S3 bucket. ```APIDOC ## POST /exportS3file ### Description Exports validation or scoring results back to your S3 bucket. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/exportS3file ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key - **file_id** (string) - Required - The ID of the completed validation or scoring job - **export_bucket** (string) - Required - The target S3 bucket for the export ### Response #### Success Response (200) - **success** (boolean) - Status of the request - **message** (string) - Confirmation message - **export_path** (string) - The path where the exported file is saved #### Response Example { "success": true, "message": "File exported successfully", "export_path": "results/january_list_validated.csv" } ``` -------------------------------- ### Bulk Email Validation: Delete File Source: https://context7.com/zerobounce/postman-v2/llms.txt Removes a validation file and its results from ZeroBounce servers. Use this endpoint to manage storage and maintain data privacy after downloading results. ```APIDOC ## Bulk Email Validation: Delete File ### Description Removes a validation file and its results from ZeroBounce servers. Use this endpoint to manage storage and maintain data privacy after downloading results. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/v2/deletefile ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The unique identifier for the file to delete. ### Request Example ```bash curl -X GET "https://bulkapi.zerobounce.net/v2/deletefile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **message** (string) - A message confirming the file deletion. - **file_name** (string) - The name of the deleted file. - **file_id** (string) - The ID of the deleted file. #### Response Example ```json { "success": true, "message": "File Deleted", "file_name": "emails.csv", "file_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" } ``` ``` -------------------------------- ### Delete Bulk Validation File Source: https://context7.com/zerobounce/postman-v2/llms.txt Removes a validation file and its results from ZeroBounce servers. Use this endpoint to manage storage and maintain data privacy after downloading results. Requires the file_id. ```bash # Delete a file from ZeroBounce servers curl -X GET "https://bulkapi.zerobounce.net/v2/deletefile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` -------------------------------- ### Delete AI Scoring File Source: https://context7.com/zerobounce/postman-v2/llms.txt Removes an AI scoring file and its results from ZeroBounce servers. Use this to manage storage and privacy. Requires the file_id. ```bash # Delete AI scoring file curl -X GET "https://bulkapi.zerobounce.net/v2/scoring/deletefile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` -------------------------------- ### Validate Batch of Email Addresses Source: https://context7.com/zerobounce/postman-v2/llms.txt Validates up to 100 email addresses in a single POST request using a JSON payload. ```bash # Batch validate multiple emails curl -X POST "https://bulkapi.zerobounce.net/v2/validatebatch" \ -H "Content-Type: application/json" \ -d '{ "api_key": "YOUR_API_KEY", "email_batch": [ {"email_address": "valid@example.com", "ip_address": "1.1.1.1"}, {"email_address": "invalid@example.com", "ip_address": "1.1.1.1"}, {"email_address": "disposable@example.com", "ip_address": null} ], "activity_data": true, "verify_plus": true }' ``` -------------------------------- ### List Evaluator: Send Evaluated File for Validation Source: https://context7.com/zerobounce/postman-v2/llms.txt Submits an already-evaluated file for full validation processing. ```APIDOC ## List Evaluator: Send Evaluated File for Validation ### Description Submits an already-evaluated file for full validation processing. ### Method POST ### Endpoint https://bulkapi.zerobounce.net/v2/send-evaluated-file/ ### Parameters #### Form Data - **api_key** (string) - Required - Your ZeroBounce API key. - **file** (file) - Required - The CSV file containing the evaluated email addresses. ``` -------------------------------- ### Check Bulk Validation File Status Source: https://context7.com/zerobounce/postman-v2/llms.txt Queries the processing status of a previously uploaded bulk validation file using its file ID. ```bash # Check the status of a bulk validation file curl -X GET "https://bulkapi.zerobounce.net/v2/filestatus?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` -------------------------------- ### AI Scoring: Delete File Source: https://context7.com/zerobounce/postman-v2/llms.txt Removes an AI scoring file and its results from ZeroBounce servers. ```APIDOC ## AI Scoring: Delete File ### Description Removes an AI scoring file and its results from ZeroBounce servers. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/v2/scoring/deletefile ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The unique identifier for the scoring file to delete. ### Request Example ```bash curl -X GET "https://bulkapi.zerobounce.net/v2/scoring/deletefile?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **message** (string) - A message confirming the file deletion. #### Response Example ```json { "success": true, "message": "File Deleted" } ``` ``` -------------------------------- ### Activity Data API Source: https://context7.com/zerobounce/postman-v2/llms.txt Retrieves activity information for an email address, indicating how recently the email has been active or engaged. This helps identify dormant or inactive email addresses. ```APIDOC ## Activity Data API ### Description Retrieves activity information for an email address, indicating how recently the email has been active or engaged. This helps identify dormant or inactive email addresses. ### Method GET ### Endpoint https://api.zerobounce.net/v2/activity ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **email** (string) - Required - The email address to check for activity. ### Request Example ```bash curl -X GET "https://api.zerobounce.net/v2/activity?api_key=YOUR_API_KEY&email=user@example.com" ``` ### Response #### Success Response (200) - **email** (string) - The email address queried. - **found** (boolean) - Indicates if activity data was found for the email. - **active_in_days** (string) - The number of days since the email was last active. #### Response Example ```json { "email": "user@example.com", "found": true, "active_in_days": "30" } ``` ``` -------------------------------- ### AI Scoring: Single Email (Real-time) Source: https://context7.com/zerobounce/postman-v2/llms.txt Uses artificial intelligence to score an email address based on its likelihood of engagement. Returns a score indicating the quality and activity level of the email. ```APIDOC ## AI Scoring: Single Email (Real-time) ### Description Uses artificial intelligence to score an email address based on its likelihood of engagement. Returns a score indicating the quality and activity level of the email. ### Method GET ### Endpoint https://api.zerobounce.net/v2/scoring ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **email** (string) - Required - The email address to score. ### Request Example ```bash curl -X GET "https://api.zerobounce.net/v2/scoring?api_key=YOUR_API_KEY&email=user@example.com" ``` ### Response #### Success Response (200) - **email** (string) - The email address that was scored. - **zerobounce_score** (string) - The AI-generated score for the email. - **processed_at** (string) - The timestamp when the email was processed. #### Response Example ```json { "email": "user@example.com", "zerobounce_score": "8", "processed_at": "2024-01-15 12:00:00.000" } ``` ``` -------------------------------- ### Validate Single Email Address Source: https://context7.com/zerobounce/postman-v2/llms.txt Performs real-time validation on a single email address with optional parameters for enhanced data. ```bash # Basic single email validation curl -X GET "https://api.zerobounce.net/v2/validate?api_key=YOUR_API_KEY&email=valid@example.com" # With optional parameters (IP address, activity data, and Verify+) curl -X GET "https://api.zerobounce.net/v2/validate?api_key=YOUR_API_KEY&email=valid@example.com&ip_address=192.168.1.1&activity_data=true&verify_plus=true&timeout=30" ``` -------------------------------- ### Export S3 File via cURL Source: https://context7.com/zerobounce/postman-v2/llms.txt Exports processed validation or scoring results back to a specified S3 bucket using a file ID. ```bash curl -X POST "https://bulkapi.zerobounce.net/exportS3file" \ -F "api_key=YOUR_API_KEY" \ -F "file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" \ -F "export_bucket=your-export-bucket" ``` -------------------------------- ### AI Scoring: File Status Source: https://context7.com/zerobounce/postman-v2/llms.txt Checks the processing status of a bulk AI scoring job. ```APIDOC ## AI Scoring: File Status ### Description Checks the processing status of a bulk AI scoring job. ### Method GET ### Endpoint https://bulkapi.zerobounce.net/v2/scoring/filestatus ### Parameters #### Query Parameters - **api_key** (string) - Required - Your ZeroBounce API key. - **file_id** (string) - Required - The unique identifier for the scoring job. ### Request Example ```bash curl -X GET "https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the status check was successful. - **file_id** (string) - The unique identifier for the scoring job. - **file_status** (string) - The current status of the job (e.g., "Complete"). - **complete_percentage** (string) - The percentage of completion for the job. #### Response Example ```json { "success": true, "file_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "file_status": "Complete", "complete_percentage": "100%" } ``` ``` -------------------------------- ### Validate S3 File via cURL Source: https://context7.com/zerobounce/postman-v2/llms.txt Initiates validation for a file stored in an S3 bucket. Requires the file name and configuration flags for header rows and duplicate removal. ```bash curl -X POST "https://bulkapi.zerobounce.net/validateS3file" \ -F "api_key=YOUR_API_KEY" \ -F "file_name=emails/january_list.csv" \ -F "has_header_row=true" \ -F "remove_duplicates=true" ``` -------------------------------- ### Check AI Scoring File Status Source: https://context7.com/zerobounce/postman-v2/llms.txt Checks the processing status of a bulk AI scoring job. Requires the file_id to query the status. ```bash # Check AI scoring file status curl -X GET "https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=YOUR_API_KEY&file_id=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" ``` -------------------------------- ### Add or Modify Allow/Block Filter Rule Source: https://context7.com/zerobounce/postman-v2/llms.txt Creates or updates custom filtering rules to always allow or block specific emails, domains, or MX records during validation. ```APIDOC ## Add or Modify Allow/Block Filter Rule ### Description Creates or updates custom filtering rules to always allow or block specific emails, domains, or MX records during validation. ### Method POST ### Endpoint https://api.zerobounce.net/v2/filters/add ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key. - **rule** (string) - Required - The type of rule: 'allow' or 'block'. - **target** (string) - Required - The target of the rule: 'email', 'domain', or 'mx'. - **value** (string) - Required - The value to apply the rule to (e.g., an email address, domain name, or MX record). ``` -------------------------------- ### Delete Allow/Block Filter Rule Source: https://context7.com/zerobounce/postman-v2/llms.txt Removes a previously created custom filtering rule. ```APIDOC ## Delete Allow/Block Filter Rule ### Description Removes a previously created custom filtering rule. ### Method POST ### Endpoint https://api.zerobounce.net/v2/filters/delete ### Parameters #### Request Body - **api_key** (string) - Required - Your ZeroBounce API key. - **rule** (string) - Required - The type of rule to delete: 'allow' or 'block'. - **target** (string) - Required - The target of the rule: 'email', 'domain', or 'mx'. - **value** (string) - Required - The value of the rule to delete. ``` -------------------------------- ### Delete Allow/Block Filter Rule Source: https://context7.com/zerobounce/postman-v2/llms.txt Remove a previously created custom filtering rule. Requires API key, rule type, target, and value of the rule to be deleted. ```bash # Delete a filter rule curl -X POST "https://api.zerobounce.net/v2/filters/delete" \ -d "api_key=YOUR_API_KEY" \ -d "rule=block" \ -d "target=domain" \ -d "value=example.com" ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.