The ZeroBounce connector lets your AI agent act in each user's ZeroBounce account. Each user connects their own ZeroBounce API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 24 tools.
- Tools
- 24
- What they doRead · write · destructive
- 12 · 7 · 512 read7 write5 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ZeroBounce connection
In AgentKit > Connections, create a ZeroBounce connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'zerobounce'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize ZeroBounce:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'zerobounce_credits_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "zerobounce"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize ZeroBounce:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="zerobounce_credits_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ZeroBounce credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolzerobounce_api_usage_getGet API validation usage between two dates.Read-onlyGet API Usage
Get API validation usage between two dates. Returns total calls, counts per status (status_valid, status_invalid, status_catch_all and others) and per sub_status, plus the start_date and end_date. Use zerobounce_api_usage_get for usage history. Use zerobounce_credits_get for the current balance. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
Inputs
end_datestringrequired- Last day of the range, format yyyy-mm-dd. Example: 2026-01-31.
start_datestringrequired- First day of the range, format yyyy-mm-dd. Example: 2026-01-01.
zerobounce_credits_getGet the account's remaining validation credit balance.Read-onlyGet Credit Balance
Get the account's remaining validation credit balance. Returns Credits, the number of credits left, or -1 when the API key is invalid. Use zerobounce_credits_get before a large job. Use zerobounce_api_usage_get for usage over a date range.
Inputs
This tool takes no inputs.
zerobounce_domain_search_file_status_getGet the processing status of a bulk Domain Search file.Read-onlyGet Domain Search File Status
Get the processing status of a bulk Domain Search file. Returns file_id, file_name, upload_date, file_status (for example Queued, Processing, Complete or Deleted), complete_percentage, return_url and error_reason when it failed. Use zerobounce_domain_search_file_status_get to poll a bulk file job started in the ZeroBounce dashboard or API. Use the matching file delete tool to remove the file when you no longer need it. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
Inputs
file_idstringrequired- ID of the bulk Domain Search file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
zerobounce_email_finder_file_status_getGet the processing status of a bulk Email Finder file.Read-onlyGet Email Finder File Status
Get the processing status of a bulk Email Finder file. Returns file_id, file_name, upload_date, file_status (for example Queued, Processing, Complete or Deleted), complete_percentage, return_url and error_reason when it failed. Use zerobounce_email_finder_file_status_get to poll a bulk file job started in the ZeroBounce dashboard or API. Use the matching file delete tool to remove the file when you no longer need it. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
Inputs
file_idstringrequired- ID of the bulk Email Finder file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
zerobounce_filters_listList the account's custom allow and block rules.Read-onlyList Allow and Block Filters
List the account's custom allow and block rules. Returns a JSON array of rules, each with rule (allow or block), target (email, domain, mx or tld) and value. Use zerobounce_filters_list to review rules; add or remove them in the ZeroBounce dashboard.
Inputs
This tool takes no inputs.
zerobounce_inbox_placement_providers_listList the mailbox and gateway seed providers available for new inbox placement tests.Read-onlyList Inbox Placement Providers
List the mailbox and gateway seed providers available for new inbox placement tests. Returns emailProviders.items and gatewayProviders.items, each provider with id, name, location, seedCount and seedIds. Use zerobounce_inbox_placement_providers_list to pick provider_ids, seed_ids or providers for zerobounce_inbox_placement_test_create.
Inputs
This tool takes no inputs.
zerobounce_inbox_placement_test_getGet one inbox placement test with its placement results.Read-onlyGet Inbox Placement Test
Get one inbox placement test with its placement results. Returns status (running or finished), inboxCount, spamCount, otherCount, notDeliveredCount, pendingCount, percentages, results and seeds, the per-seed placement. Use zerobounce_inbox_placement_test_get to poll a test until status is finished. Use zerobounce_inbox_placement_tests_list to find test IDs.
Inputs
test_idstringrequired- ID of the inbox placement test, from zerobounce_inbox_placement_test_create or zerobounce_inbox_placement_tests_list. Example: 123.
zerobounce_inbox_placement_test_types_listList the supported inbox placement test types and the default.Read-onlyList Inbox Placement Test Types
List the supported inbox placement test types and the default. Returns each type's value and name (1 Email, 2 Unique ID, 3 Auto Alias) and the default type. Use zerobounce_inbox_placement_test_types_list before zerobounce_inbox_placement_test_create when you need the test_type values.
Inputs
This tool takes no inputs.
zerobounce_inbox_placement_tests_listList the inbox placement tests created with this API key, newest first.Read-onlyList Inbox Placement Tests
List the inbox placement tests created with this API key, newest first. Returns a page of tests with their id, name, type, status (running or finished) and placement counts. Use zerobounce_inbox_placement_tests_list to find a test. Use zerobounce_inbox_placement_test_get for one test's full per-seed results.
Inputs
created_afterstring- Only tests created after this ISO 8601 datetime. Example: 2026-01-01T00:00:00Z.
created_beforestring- Only tests created before this ISO 8601 datetime. Example: 2026-12-31T23:59:59Z.
pageinteger- Page number, starting at 1 (default 1). Example: 1.
page_sizeinteger- Tests per page, 1 to 100 (default 25). Example: 25.
statusstring- Only return running or finished tests. Example: finished.one of
runningfinished
zerobounce_inbox_placement_webhook_getGet the default webhook URL that receives finished inbox placement test results for this API key.Read-onlyGet Inbox Placement Webhook
Get the default webhook URL that receives finished inbox placement test results for this API key. Returns webhookUrl, or an empty string when none is set. Use zerobounce_inbox_placement_webhook_get to check the URL. Use zerobounce_inbox_placement_webhook_set to change it.
Inputs
This tool takes no inputs.
zerobounce_scoring_file_status_getGet the processing status of a bulk A.I.Read-onlyGet Scoring File Status
Get the processing status of a bulk A.I. scoring file. Returns file_id, file_name, upload_date, file_status (for example Queued, Processing, Complete or Deleted), complete_percentage, return_url and error_reason when it failed. Use zerobounce_scoring_file_status_get to poll a bulk file job started in the ZeroBounce dashboard or API. Use the matching file delete tool to remove the file when you no longer need it. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
Inputs
file_idstringrequired- ID of the bulk A.I. scoring file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
zerobounce_validation_file_status_getGet the processing status of a bulk validation file.Read-onlyGet Validation File Status
Get the processing status of a bulk validation file. Returns file_id, file_name, upload_date, file_status (for example Queued, Processing, Complete or Deleted), complete_percentage, return_url and error_reason when it failed. Use zerobounce_validation_file_status_get to poll a bulk file job started in the ZeroBounce dashboard or API. Use the matching file delete tool to remove the file when you no longer need it. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
Inputs
file_idstringrequired- ID of the bulk validation file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
zerobounce_domain_searchFind the email address formats a company domain uses; a found format spends 20 credits or one Email Finder query.WriteSearch Domain Email Format
Find the email address formats a company domain uses; a found format spends 20 credits or one Email Finder query. Returns domain, company_name, format (for example first.last), confidence (HIGH, MEDIUM, LOW or UNKNOWN), failure_reason and other_domain_formats with their own confidence. Use zerobounce_domain_search for a company's pattern. Use zerobounce_email_find for a specific person's address. ZeroBounce requires its approval before Domain Search is used inside a third-party product. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
company_namestring- Company name to look up when you do not know the domain. Give domain or company_name (exactly one is needed). Example: Example Company LLC.
domainstring- Email domain of the company, without @. Give domain or company_name (exactly one is needed). Example: example.com.
zerobounce_email_activity_getCheck how recently an email inbox showed activity.WriteGet Email Activity
Check how recently an email inbox showed activity. Returns found, active_in_days (30, 60, 90, 180, 365 or 365+) and active_first_seen, or null values when no activity is known. Use zerobounce_email_activity_get for engagement only. Use zerobounce_email_validate with activity_data for validation plus activity in one call. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
emailstringrequired- The email address to look up. Example: valid@example.com.
zerobounce_email_findFind a person's business email address from their name and company domain or company name; a found address spends 20 credits or one Email Finder query.WriteFind Email
Find a person's business email address from their name and company domain or company name; a found address spends 20 credits or one Email Finder query. Returns email, email_confidence (HIGH, MEDIUM or LOW), domain, company_name, did_you_mean and failure_reason when nothing is found. Use zerobounce_email_find for a named person. Use zerobounce_domain_search for the email format a company uses. ZeroBounce requires its approval before Email Finder is used inside a third-party product. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
first_namestringrequired- First name of the person. Example: John.
company_namestring- Company name to look up when you do not know the domain. Give domain or company_name (exactly one is needed). Example: Example Company LLC.
domainstring- Email domain of the person's company, without @. Give domain or company_name (exactly one is needed). Example: example.com.
last_namestring- Last name of the person. Recommended. Example: Doe.
middle_namestring- Middle name of the person, if known. Example: Michael.
zerobounce_email_scoreGet the A.I.WriteScore Email
Get the A.I. score for one email address in real time; a successful score spends credits. Returns email and score, a 0 to 10 quality score where higher means more likely to engage. Use zerobounce_email_score to rank addresses by quality, for example catch-all or unknown results. Use zerobounce_email_validate to check deliverability. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
emailstringrequired- The email address to score. Example: valid@example.com.
zerobounce_email_validateValidate one email address in real time and spend one credit unless the result is unknown.WriteValidate Email
Validate one email address in real time and spend one credit unless the result is unknown. Returns status (valid, invalid, catch-all, unknown, spamtrap, abuse, do_not_mail), sub_status, did_you_mean, free_email, mx_found, mx_record, smtp_provider, domain_age_days, owner name and gender when known, IP geolocation, and activity or domain data when requested. Use zerobounce_email_validate for one address at a time; for a large list, run a bulk file job in the ZeroBounce dashboard. The sandbox addresses (valid@example.com, invalid@example.com, catch_all@example.com and others) return fixed results and spend no credits. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
emailstringrequired- The email address to validate. Example: valid@example.com.
activity_databoolean- Set true to add active_in_days and active_first_seen (how recently the inbox showed activity). Example: true.
domain_infoboolean- Set true to add domain_website_exists, domain_registrant_company_name and domain_detected_services (WHOIS and website availability). Adds processing time. Example: true.
ip_addressstring- IP address the email signed up from, used for the city, region, zipcode and country fields. Optional. Example: 99.110.204.1.
timeoutinteger- How long ZeroBounce may spend validating, 3 to 60 seconds (default 30). When the limit is reached the result is unknown with sub_status timeout_exceeded. Keep it at 8 or less to stay inside the tool call timeout. Example: 8.
verify_plusboolean- Set true to force the Verify+ method for this call, or false to force it off, overriding the account setting. Leave empty to use the account setting. Example: true.
zerobounce_inbox_placement_test_createCreate an inbox placement test and get the seed addresses to send your campaign to; it spends one inbox test credit.WriteCreate Inbox Placement Test
Create an inbox placement test and get the seed addresses to send your campaign to; it spends one inbox test credit. Returns id, identifier, testType and emailAddressList, the seed addresses. Use zerobounce_inbox_placement_test_create to start a test, then send the campaign to every seed (for Unique ID tests, put the identifier in the subject or body). Poll zerobounce_inbox_placement_test_get until status is finished. Call zerobounce_inbox_placement_providers_list first to pick provider or seed IDs; without them every active seed is used.
Inputs
namestringrequired- Unique test name, up to 64 characters of letters, digits, spaces and - / \ , . & ' ( ). Must not match a running or finished test. Example: March newsletter.
provider_idsarray- Use all active seeds of these providers, by ID from zerobounce_inbox_placement_providers_list. Example: [12].
providersarray- Limit the number of seeds per provider. Each entry has the provider id and maxSeeds (at least 1). Example: [{"id": 12, "maxSeeds": 3}].
seed_idsarray- Use these specific seed mailboxes, by ID from zerobounce_inbox_placement_providers_list. Example: [101, 102].
sender_emailstring- From address the campaign is sent from. Required when test_type is 1. Example: newsletter@example.com.
test_typeinteger- How sent messages are matched to the test: 3 = Auto Alias (default; send to the returned list, which includes a testid+identifier@zbtest.org alias), 2 = Unique ID (put the returned identifier in the subject or body), 1 = Email (match on the From address; sender_email is required). Example: 3.one of
123 webhook_urlstring- URL ZeroBounce POSTs the finished results to. It is also saved as the API key's default webhook. Example: https://example.com/ipt-hook.
zerobounce_inbox_placement_webhook_setSet the default webhook URL that receives finished inbox placement test results for this API key.WriteSet Inbox Placement Webhook
Set the default webhook URL that receives finished inbox placement test results for this API key. Returns the saved webhookUrl. Use zerobounce_inbox_placement_webhook_set to change where results go. ZeroBounce POSTs each finished test once, with the same body as zerobounce_inbox_placement_test_get.
- Idempotent
Inputs
webhook_urlstringrequired- HTTPS URL that accepts a JSON POST and answers 2xx. Example: https://example.com/ipt-hook.
zerobounce_domain_search_file_deleteDelete a bulk Domain Search file and its results from ZeroBounce.DestructiveDelete Domain Search File
Delete a bulk Domain Search file and its results from ZeroBounce. Returns success, message, file_name and file_id. Use zerobounce_domain_search_file_delete after you have exported the results. Use zerobounce_domain_search_file_status_get to check the file first. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
file_idstringrequired- ID of the bulk Domain Search file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
zerobounce_email_finder_file_deleteDelete a bulk Email Finder file and its results from ZeroBounce.DestructiveDelete Email Finder File
Delete a bulk Email Finder file and its results from ZeroBounce. Returns success, message, file_name and file_id. Use zerobounce_email_finder_file_delete after you have exported the results. Use zerobounce_email_finder_file_status_get to check the file first. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
file_idstringrequired- ID of the bulk Email Finder file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
zerobounce_inbox_placement_test_deleteDelete a finished inbox placement test.DestructiveDelete Inbox Placement Test
Delete a finished inbox placement test. Returns the id and status deleted (or an empty 204). A running test cannot be deleted (400). Use zerobounce_inbox_placement_test_delete to clean up old tests. Use zerobounce_inbox_placement_test_get to check it is finished first.
- Idempotent
Inputs
test_idstringrequired- ID of the inbox placement test, from zerobounce_inbox_placement_test_create or zerobounce_inbox_placement_tests_list. Example: 123.
zerobounce_scoring_file_deleteDelete a bulk A.I.DestructiveDelete Scoring File
Delete a bulk A.I. scoring file and its results from ZeroBounce. Returns success, message, file_name and file_id. Use zerobounce_scoring_file_delete after you have exported the results. Use zerobounce_scoring_file_status_get to check the file first. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
file_idstringrequired- ID of the bulk A.I. scoring file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
zerobounce_validation_file_deleteDelete a bulk validation file and its results from ZeroBounce.DestructiveDelete Validation File
Delete a bulk validation file and its results from ZeroBounce. Returns success, message, file_name and file_id. Use zerobounce_validation_file_delete after you have exported the results. Use zerobounce_validation_file_status_get to check the file first. ZeroBounce reports most errors (bad key, no credits, missing parameter) as HTTP 200 with an error or Message field, so check the body.
- Idempotent
Inputs
file_idstringrequired- ID of the bulk validation file, as returned when the job was started (by an S3 or SFTP job tool here, or by a dashboard or sendfile upload). Example: aaaaaaaa-0000-0000-0000-000000000000.
No tools match.