Zerobounce

Learn how to use Zerobounce with Composio

Overview

SLUG: ZEROBOUNCE

Description

ZeroBounce is an email validation and deliverability platform that helps businesses improve email marketing performance by identifying and removing invalid or risky email addresses.

Authentication Details

generic_api_key
stringRequired
generic_api_key
stringRequired

Connecting to Zerobounce

Create an auth config

Use the dashboard to create an auth config for the Zerobounce toolkit. This allows you to connect multiple Zerobounce accounts to Composio for agents to use.

1

Select App

Navigate to Zerobounce.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Zerobounce Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4zerobounce_auth_config_id = "ac_YOUR_ZEROBOUNCE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Zerobounce for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, zerobounce_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Zerobounce toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["ZEROBOUNCE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get Activity Data

Description

Tool to get activity data (opens, clicks, etc.) for a given email. use after confirming the email address to gauge engagement recency.

Action Parameters

email
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: AI Scoring Single Email

Description

Tool to score a single email address using zerobounce ai. use when you need real-time email lead quality feedback before outreach. example prompt: "score the email mark@gmail.com."

Action Parameters

email
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Allow or Block List

Description

Tool to manage allowlist and blocklist for email validation. use when you need to programmatically add or modify custom filters before validating emails.

Action Parameters

rule
stringRequired
target
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Batch Validate Emails

Description

Tool to validate a batch of email addresses in real time. use when you need to validate up to 200 emails at once with optional activity data.

Action Parameters

activity_data
boolean
api_key
stringRequired
email_batch
arrayRequired
timeout
integer
verify_plus
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete file

Description

Tool to delete a file that was submitted for bulk validation. use when file status is 'complete'.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Domain Search File Status

Description

Tool to get the processing status of a file submitted for bulk domain search. use after submitting the file to poll status.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Domain Search Get File

Description

Tool to download the results file for a completed bulk domain search job. use when you have the file id and the job is complete.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Domain Search Send File

Description

Tool to upload a file for bulk domain search. use when you have many domains in a csv/txt and need to lookup their details in bulk.

Action Parameters

domain_column
integerRequired
file
stringRequired
file_name
stringRequired
has_header_row
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Domain Search Single

Description

Tool to identify common email address formats for a given domain. use when you need to guess email patterns for a company based on its domain.

Action Parameters

company_name
string
domain
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Email Finder File

Description

Tool to delete a file that was submitted for bulk email finding. use when the file processing status is 'complete' and you need to remove it.

Action Parameters

api_key
stringRequired
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Email Finder File Status

Description

Tool to get the processing status of a file submitted for bulk email finding. use when you need to poll the progress of a bulk email-finder file upload.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Email Finder Send File

Description

Tool to upload a file for bulk email finding. use when you have lists of names and domains to find emails in bulk via csv/txt upload.

Action Parameters

domain_column
integerRequired
file
stringRequired
file_name
stringRequired
first_name_column
integer
full_name_column
integer
has_header_row
boolean
last_name_column
integer
middle_name_column
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Email Finder Single

Description

Tool to find an email address for a given person and domain. use when you need to locate a professional email from a person's name and company domain. use after confirming domain or company info.

Action Parameters

company_name
string
domain
string
first_name
string
last_name
string
middle_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get API Usage

Description

Tool to retrieve api usage statistics for a given period. use when you need usage metrics between two dates.

Action Parameters

end_date
Required
start_date
Required

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Credit Balance

Description

Tool to retrieve your current zerobounce email validation credit balance. use when you need to monitor remaining credits to avoid service interruptions.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Evaluator

Description

Tool to evaluate the quality of an email list. use when you have a list of emails and need a quick health check before full validation.

Action Parameters

email_address_column
integerRequired
file
stringRequired
file_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send File

Description

Tool to upload a file for bulk email validation. use when you need to validate large lists of emails via csv or txt file.

Action Parameters

email_address_column
integerRequired
file
stringRequired
file_name
stringRequired
first_name_column
integer
gender_column
integer
has_header_row
boolean
ip_address_column
integer
last_name_column
integer
remove_duplicate
boolean
return_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Validate Email

Description

Tool to validate a single email address in real time. use when you need to confirm deliverability and domain details before sending emails.

Action Parameters

credits_info
boolean
email
Required
ip_address

Action Response

data
objectRequired
error
string
successful
booleanRequired