The Benchmark Email connector lets your AI agent act in each user's Benchmark Email account. Each user connects their own Benchmark Email API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 57 tools.
- Tools
- 57
- What they doRead · write · destructive
- 36 · 14 · 736 read14 write7 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 Benchmark Email connection
In AgentKit > Connections, create a Benchmark Email 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 = 'benchmarkemail'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Benchmark Email:', 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: 'benchmarkemail_account_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 = "benchmarkemail"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Benchmark Email:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="benchmarkemail_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Benchmark Email credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbenchmarkemail_account_getGet the Benchmark Email account profile.Read-onlyGet Account Details
Get the Benchmark Email account profile. Returns the account's name, company, login email, address, plan and settings in Response.Data. Use it to confirm the connection works and see who the API token belongs to.
Inputs
This tool takes no inputs.
benchmarkemail_automation_getGet one automation by ID.Read-onlyGet Automation
Get one automation by ID. Returns the automation's name, type, sender, target list, status and its emails in Response.Data. Use benchmarkemail_automations_list to find the ID.
Inputs
automation_idstringrequired- ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.
benchmarkemail_automation_report_getGet the summary report for an automation.Read-onlyGet Automation Report
Get the summary report for an automation. Returns sends, opens, clicks, bounces and unsubscribes for each email in the automation in Response.Data.
Inputs
automation_idstringrequired- ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.
benchmarkemail_automations_listList automations (autoresponder series), with paging, sorting and a name filter.Read-onlyList Automations
List automations (autoresponder series), with paging, sorting and a name filter. Returns each automation's ID, name, status, list and email count in Response.Data. Use benchmarkemail_automation_get for one automation's details.
Inputs
This tool takes no inputs.
benchmarkemail_confirmed_emails_listList the sender email addresses confirmed in the account.Read-onlyList Confirmed Sender Emails
List the sender email addresses confirmed in the account. Returns the confirmed From addresses in Response.Emails. Use it before benchmarkemail_email_create to pick a valid from_email.
Inputs
This tool takes no inputs.
benchmarkemail_contact_getGet one contact in a contact list by contact ID.Read-onlyGet Contact
Get one contact in a contact list by contact ID. Returns the contact's email, names, field values, opt-in data and status in Response.Data. Use benchmarkemail_contacts_search or benchmarkemail_list_contacts_list to find the contact ID.
Inputs
contact_idstringrequired- ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_contact_history_getGet the campaign history for one email address.Read-onlyGet Contact Email History
Get the campaign history for one email address. Returns the campaigns sent to the address and its opens, clicks and bounces in Response.Data. Use it to see one subscriber's engagement.
Inputs
emailstringrequired- Email address of the contact. Example: jane@example.com.
order_bystring- Field to sort by. Example: date.
page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc
benchmarkemail_contact_import_status_getGet the status of recent contact imports.Read-onlyGet Contact Import Status
Get the status of recent contact imports. Returns each import's type, list IDs, contacts found and contacts added in Response.Data. Use it after benchmarkemail_contacts_bulk_add to check progress.
Inputs
This tool takes no inputs.
benchmarkemail_contacts_searchSearch all contact lists for a contact by email address.Read-onlySearch Contacts
Search all contact lists for a contact by email address. Returns matching contacts with their list IDs, contact IDs and status in Response.Data. Use it to find which lists an email is on. Use benchmarkemail_list_contacts_list to browse one list.
Inputs
searchstringrequired- Email address (or part of one) to search for. Example: jane@example.com.
search_filterstring- Optional extra filter value. Example: 1.
benchmarkemail_email_getGet one email campaign by ID.Read-onlyGet Email
Get one email campaign by ID. Returns the campaign's name, subject, sender, content, target lists, status and schedule in Response.Data. Use benchmarkemail_emails_list to find the ID. Use benchmarkemail_email_report_get for its results.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_recipient_count_getCount how many contacts an email campaign will be sent to.Read-onlyGet Email Recipient Count
Count how many contacts an email campaign will be sent to. Returns Response.Count. Use it before benchmarkemail_email_schedule to check the audience size.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_report_bounces_listList the contacts who bounced for a sent email campaign, with paging.Read-onlyList Email Bounces
List the contacts who bounced for a sent email campaign, with paging. Returns each contact's email and the event details in Response.Data, with Response.Count. Use benchmarkemail_email_report_get for the totals.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_report_click_performance_getGet link click performance for a sent email campaign.Read-onlyGet Email Click Performance
Get link click performance for a sent email campaign. Returns each link URL with its total and unique clicks in Response.Data. Use benchmarkemail_email_report_clicks_list for who clicked.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_report_clicks_listList the contacts who clicked a link for a sent email campaign, with paging.Read-onlyList Email Clicks
List the contacts who clicked a link for a sent email campaign, with paging. Returns each contact's email and the event details in Response.Data, with Response.Count. Use benchmarkemail_email_report_get for the totals.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_report_forwards_listList the contacts who forwarded the email for a sent email campaign, with paging.Read-onlyList Email Forwards
List the contacts who forwarded the email for a sent email campaign, with paging. Returns each contact's email and the event details in Response.Data, with Response.Count. Use benchmarkemail_email_report_get for the totals.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_report_getGet the summary report for one sent email campaign.Read-onlyGet Email Report
Get the summary report for one sent email campaign. Returns sends, opens, clicks, bounces, unsubscribes, forwards and abuse reports, with rates, in Response.Data. Use the benchmarkemail_email_report_* list tools for the contacts behind each number.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_report_opens_listList the contacts who opened for a sent email campaign, with paging.Read-onlyList Email Opens
List the contacts who opened for a sent email campaign, with paging. Returns each contact's email and the event details in Response.Data, with Response.Count. Use benchmarkemail_email_report_get for the totals.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
filterstring- Text to match against email addresses. Example: example.com.
order_bystring- Field to sort by, such as email. Example: email.
page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc
benchmarkemail_email_report_unopens_listList the contacts who did not open for a sent email campaign, with paging.Read-onlyList Email Non-Openers
List the contacts who did not open for a sent email campaign, with paging. Returns each contact's email and the event details in Response.Data, with Response.Count. Use benchmarkemail_email_report_get for the totals.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_report_unsubscribes_listList the contacts who unsubscribed for a sent email campaign, with paging.Read-onlyList Email Unsubscribes
List the contacts who unsubscribed for a sent email campaign, with paging. Returns each contact's email and the event details in Response.Data, with Response.Count. Use benchmarkemail_email_report_get for the totals.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_email_reports_listList sent email campaigns with their headline results.Read-onlyList Email Reports
List sent email campaigns with their headline results. Returns each sent campaign's ID, name, send date, sends, opens, clicks, bounces and unsubscribes in Response.Data. Use it to compare campaigns. Use benchmarkemail_email_report_get for one campaign.
Inputs
ab_filterstring- A/B test filter. Example: 0.
filterstring- Text to match against campaign names. Example: Newsletter.
filter_typestring- Filter type. Example: 1.
order_bystring- Field to sort by. Example: date.
page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc
benchmarkemail_email_spam_checkRun a spam check on an email campaign's content.Read-onlyCheck Email Spam Score
Run a spam check on an email campaign's content. Returns the spam score and the rules it triggered in Response.Data. Use it before sending to catch content likely to be filtered.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_emails_listList email campaigns, with paging, sorting, a name filter and a status filter.Read-onlyList Emails
List email campaigns, with paging, sorting, a name filter and a status filter. Returns each campaign's ID, name, subject, status and schedule date in Response.Data. Use it to find a campaign ID. Use benchmarkemail_email_get for one campaign's full details.
Inputs
exclude_email_idstring- Campaign ID to leave out of the results. Example: 8754320.
filterstring- Text to match against campaign names. Example: Newsletter.
filter_typestring- Filter type. Example: 1.
order_bystring- Field to sort by: email, date, count or schedule. Example: date.one of
emaildatecountschedule page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc statusstring- Campaign status filter. Example: 1.
benchmarkemail_list_contact_summary_getGet a contact list's subscriber summary.Read-onlyGet Contact List Summary
Get a contact list's subscriber summary. Returns counts of active, unsubscribed, bounced and other contacts in the list. Use it for list health. Use benchmarkemail_list_contacts_list for the contacts themselves.
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_list_contacts_listList the contacts in one contact list, with search, status filter, paging and sorting.Read-onlyList Contacts in List
List the contacts in one contact list, with search, status filter, paging and sorting. Returns each contact's ID, email, names, fields and status in Response.Data, with Response.Count. Use it to browse a list. Use benchmarkemail_contacts_search to find an email across all lists.
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
filterstring- Contact status filter: 2 unsubscribed, 5 hard bounced, 100 all other contacts (not unsubscribed or hard bounced). Example: 100.one of
25100 order_bystring- Field to sort by: email, firstname, lastname or date. Example: email.one of
emailfirstnamelastnamedate page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
search_fieldstring- Field to search, such as email, name, address, date1 or date2. Example: email.
search_filterstring- Value to search for in the field chosen by search_field. Example: jane.
search_typestring- How search_filter matches: 1 starts with, 2 exact, 3 contains, 4 ends with. Example: 3.one of
1234 sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc
benchmarkemail_list_fields_getGet the field labels and types defined on a contact list.Read-onlyGet Contact List Fields
Get the field labels and types defined on a contact list. Returns the list's field names (Field1 to Field24) and their types in Response.Data. Use it to learn which field1..field24 keys to set in benchmarkemail_contact_add.
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_list_getGet one contact list by ID.Read-onlyGet Contact List
Get one contact list by ID. Returns the list name, description, field labels, contact counts and created date in Response.Data. Use benchmarkemail_lists_list to find the ID. Use benchmarkemail_list_fields_get for field names only.
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_list_webhooks_listList the webhooks set on a contact list.Read-onlyList List Webhooks
List the webhooks set on a contact list. Returns each webhook's ID, URL and which events it reports in Response.Data. Use it before updating or deleting a webhook.
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_lists_listList contact lists in the account, with paging, sorting and a name filter.Read-onlyList Contact Lists
List contact lists in the account, with paging, sorting and a name filter. Returns each list's ID, name, contact count and dates in Response.Data, with Response.Count. Use it to find a list ID. Use benchmarkemail_list_get for one list's details.
Inputs
order_bystring- Field to sort by: email, date, count or schedule. Example: date.one of
emaildatecountschedule page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
search_filterstring- Text to match against list names. Example: Newsletter.
sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc statusstring- Status filter. Example: 1.
benchmarkemail_segment_contacts_listList the contacts that match a segment, with search, paging and sorting.Read-onlyList Segment Contacts
List the contacts that match a segment, with search, paging and sorting. Returns each matching contact's email, names and fields in Response.Data, with Response.Count. Use benchmarkemail_list_contacts_list for a whole list.
Inputs
segment_idstringrequired- ID of the segment. Get it from benchmarkemail_segments_list. Example: 123456.
order_bystring- Field to sort by: email or date. Example: email.one of
emaildate page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
search_fieldstring- Field to search: Email or Name. Example: Email.
search_filterstring- Value to search for. Example: jane.
search_typestring- How search_filter matches: 1 starts with, 2 exact, 3 contains, 4 ends with. Example: 3.one of
1234 sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc
benchmarkemail_segment_getGet one segment by ID.Read-onlyGet Segment
Get one segment by ID. Returns the segment's name, description, list and criteria in Response.Data. Use benchmarkemail_segments_list to find the ID.
Inputs
segment_idstringrequired- ID of the segment. Get it from benchmarkemail_segments_list. Example: 123456.
benchmarkemail_segments_listList contact segments, with paging, sorting and a name filter.Read-onlyList Segments
List contact segments, with paging, sorting and a name filter. Returns each segment's ID, name, list and contact count in Response.Data. Use benchmarkemail_segment_contacts_list for the contacts in a segment.
Inputs
filterstring- Text to match against segment names. Example: VIP.
order_bystring- Field to sort by: name or date. Example: date.one of
namedate page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc
benchmarkemail_signup_form_getGet one signup form by ID.Read-onlyGet Signup Form
Get one signup form by ID. Returns the form's name, linked lists, fields and settings in Response.Data. Use benchmarkemail_signup_forms_list to find the ID.
Inputs
signup_form_idstringrequired- ID of the signup form. Get it from benchmarkemail_signup_forms_list. Example: 556677.
benchmarkemail_signup_forms_listList the signup forms in the account, with paging, sorting and a filter.Read-onlyList Signup Forms
List the signup forms in the account, with paging, sorting and a filter. Returns each form's ID, name, linked lists and dates in Response.Data. Use benchmarkemail_signup_form_get for one form.
Inputs
This tool takes no inputs.
benchmarkemail_survey_getGet one survey by ID.Read-onlyGet Survey
Get one survey by ID. Returns the survey's name, status, settings and questions in Response.Data. Use benchmarkemail_surveys_list to find the ID.
Inputs
survey_idstringrequired- ID of the survey. Get it from benchmarkemail_surveys_list. Example: 334455.
benchmarkemail_surveys_listList surveys in the account, with paging, sorting and a name filter.Read-onlyList Surveys
List surveys in the account, with paging, sorting and a name filter. Returns each survey's ID, name, status and response count in Response.Data. Use benchmarkemail_survey_get for one survey.
Inputs
This tool takes no inputs.
benchmarkemail_templates_listList the email templates available to the account, with paging and a name filter.Read-onlyList Email Templates
List the email templates available to the account, with paging and a name filter. Returns each template's ID, name and category in Response.Data. Use it to pick a design for a new campaign.
Inputs
order_bystring- Field to sort by. Example: date.
page_numberinteger- Page number to return, starting at 1. Example: 1.
page_sizeinteger- Number of records per page. Example: 25.
search_filterstring- Text to match against template names. Example: newsletter.
sort_orderstring- Sort direction: asc or desc. Example: desc.one of
ascdesc statusstring- Status filter. Example: 1.
benchmarkemail_contact_addAdd one contact to a contact list.WriteAdd Contact to List
Add one contact to a contact list. Returns the new contact in Response.Data. Use benchmarkemail_contact_update to change an existing contact. Use benchmarkemail_contacts_bulk_add to add many email addresses at once.
Inputs
emailstringrequired- Email address of the contact. Example: jane@example.com.
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
email_permstring- 1 if the contact gave permission to receive email, 0 if not. Example: 1.one of
10 email_typestring- Preferred email format: html or text. Example: html.one of
htmltext field1string- Field 1 value (Address by default; see benchmarkemail_list_fields_get for this list's labels). Example: 1 Main St.
field10string- Field 10 value (Job title by default). Example: Marketing Manager.
field2string- Field 2 value (City by default). Example: Austin.
field3string- Field 3 value (State by default). Example: TX.
field4string- Field 4 value (Zip by default). Example: 78701.
field5string- Field 5 value (Country by default). Example: US.
field6string- Field 6 value (Phone by default). Example: +1 512 555 0100.
field7string- Field 7 value (Fax by default). Example: +1 512 555 0101.
field8string- Field 8 value (Cell phone by default). Example: +1 512 555 0102.
field9string- Field 9 value (Company name by default). Example: Acme Inc.
first_namestring- First Name of the contact. Example: Jane.
last_namestring- Last Name of the contact. Example: Doe.
middle_namestring- Middle Name of the contact. Example: Q.
benchmarkemail_contact_updateUpdate a contact's email, names or field values in a contact list.WriteUpdate Contact
Update a contact's email, names or field values in a contact list. Returns the updated contact in Response.Data. Only the fields you pass change. Use benchmarkemail_contact_add for a new contact.
Inputs
contact_idstringrequired- ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
emailstring- Email address of the contact. Example: jane@example.com.
email_permstring- 1 if the contact gave permission to receive email, 0 if not. Example: 1.one of
10 email_typestring- Preferred email format: html or text. Example: html.one of
htmltext field1string- Field 1 value (Address by default). Example: 1 Main St.
field10string- Field 10 value (Job title by default). Example: Marketing Manager.
field2string- Field 2 value (City by default). Example: Austin.
field3string- Field 3 value (State by default). Example: TX.
field4string- Field 4 value (Zip by default). Example: 78701.
field5string- Field 5 value (Country by default). Example: US.
field6string- Field 6 value (Phone by default). Example: +1 512 555 0100.
field7string- Field 7 value (Fax by default). Example: +1 512 555 0101.
field8string- Field 8 value (Cell phone by default). Example: +1 512 555 0102.
field9string- Field 9 value (Company name by default). Example: Acme Inc.
first_namestring- First Name of the contact. Example: Jane.
last_namestring- Last Name of the contact. Example: Doe.
middle_namestring- Middle Name of the contact. Example: Q.
benchmarkemail_contacts_bulk_addAdd several email addresses to a contact list in one call.WriteAdd Email Addresses to List
Add several email addresses to a contact list in one call. Returns Response.Count found and Response.TotalAdded. Use it to add many addresses without names. Use benchmarkemail_contact_add for one contact with fields.
Inputs
email_i_dsstringrequired- Email addresses to add, separated by commas or new lines. Example: jane@example.com,john@example.com.
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_contacts_copyCopy contacts into one or more other contact lists.WriteCopy Contacts
Copy contacts into one or more other contact lists. Returns Response.Status. Use benchmarkemail_contacts_move to remove them from the source list.
Inputs
contact_i_dsstringrequired- Contact IDs to copy, separated by commas. Example: 2380718261,2380718262.
target_list_i_dsstringrequired- ID of the destination list; separate several IDs with commas. Example: 15981790.
benchmarkemail_contacts_moveMove contacts from one contact list to one or more other lists.WriteMove Contacts
Move contacts from one contact list to one or more other lists. Returns Response.Status. Use benchmarkemail_contacts_copy to keep them in the source list too.
Inputs
contact_i_dsstringrequired- Contact IDs to move, separated by commas. Example: 2380718261,2380718262.
list_idstringrequired- ID of the source contact list the contacts are in now. Example: 15981783.
target_list_i_dsstringrequired- ID of the destination list; separate several IDs with commas. Example: 15981790.
benchmarkemail_email_copyMake a copy of an email campaign under a new name.WriteCopy Email
Make a copy of an email campaign under a new name. Returns the new campaign in Response.Data, including its ID. Use it to reuse a past campaign's content.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
namestringrequired- Name for the copy. Example: Copy of May Newsletter.
benchmarkemail_email_createCreate a draft email campaign with its subject, sender, HTML content and target lists.WriteCreate Email
Create a draft email campaign with its subject, sender, HTML content and target lists. Returns the new campaign in Response.Data, including its ID. Use benchmarkemail_email_schedule to send it. Use benchmarkemail_email_test_send to preview it first.
Inputs
from_emailstringrequired- Sender email; must be a confirmed address from benchmarkemail_confirmed_emails_list. Example: news@acme.com.
from_namestringrequired- Sender name. Example: Acme Marketing.
namestringrequired- Internal name of the campaign. Example: May Newsletter.
subjectstringrequired- Subject line. Example: Our May update.
contact_listsarray- Lists or segments to send to: an array of objects with ID, Name, IsSegment ("1" for a segment, "0" for a list) and SegmentID. Example: [{"ID":"15981783","IsSegment":"0","Name":"Newsletter","SegmentID":""}].
exclude_contact_listsarray- Lists or segments to leave out, in the same shape as contact_lists. Example: [{"ID":"15981790","IsSegment":"0","Name":"Unengaged","SegmentID":""}].
google_analytics_campaignstring- Google Analytics campaign name to tag links with. Example: may-newsletter.
has_webpage_versionstring- 1 to include a link to a web page version, 0 to leave it out. Example: 1.one of
10 inbox_preview_textstring- Preview text shown in the inbox. Example: What's new this month.
is_manual_textstring- 1 to use template_text as written, 0 to generate the text version from the HTML. Example: 0.one of
10 reply_emailstring- Reply-to email address. Example: support@acme.com.
template_contentstring- HTML body of the email. Example: <html><body><h1>Hello</h1></body></html>.
template_textstring- Plain-text body of the email. Example: Hello.
versionstring- Editor version of the email: 1 for the classic editor, 2 for the drag-and-drop editor. Example: 1.one of
12
benchmarkemail_email_scheduleSchedule a draft email campaign to send at a date and time, or resend a sent one.WriteSchedule Email
Schedule a draft email campaign to send at a date and time, or resend a sent one. Returns Response.Status. The campaign needs a subject, sender, content and target lists first. Run benchmarkemail_email_test_send before scheduling.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
schedule_datestringrequired- Date and time to send, for example 05/20/2026 09:00 AM. Use the account's date format. Example: 05/20/2026 09:00 AM.
time_zonestringrequired- Time zone of schedule_date, for example America/New_York or EST. Example: America/New_York.
list_idstring- Only for a resend: list ID of the contacts to target. Example: 15981783.
send_typestring- Only for a resend: 2 to send to the same list again, 3 to send to a fixed set of other contacts (segment). Example: 2.one of
23
benchmarkemail_email_test_sendSend a test copy of an email campaign to up to a few addresses.WriteSend Test Email
Send a test copy of an email campaign to up to a few addresses. Returns Response.Status. Use it to preview a campaign before benchmarkemail_email_schedule.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
emailsstringrequired- Email addresses to send the test to, separated by commas. Example: jane@example.com,john@example.com.
messagestringrequired- Short note included with the test email. Example: Please review this draft.
benchmarkemail_email_updateUpdate a draft email campaign's subject, sender, content or target lists.WriteUpdate Email
Update a draft email campaign's subject, sender, content or target lists. Returns the updated campaign in Response.Data. Only the fields you pass change.
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
contact_listsarray- Lists or segments to send to: an array of objects with ID, Name, IsSegment ("1" for a segment, "0" for a list) and SegmentID. Example: [{"ID":"15981783","IsSegment":"0","Name":"Newsletter","SegmentID":""}].
exclude_contact_listsarray- Lists or segments to leave out, in the same shape as contact_lists. Example: [{"ID":"15981790","IsSegment":"0","Name":"Unengaged","SegmentID":""}].
from_emailstring- Sender email; must be a confirmed address from benchmarkemail_confirmed_emails_list. Example: news@acme.com.
from_namestring- Sender name. Example: Acme Marketing.
google_analytics_campaignstring- Google Analytics campaign name to tag links with. Example: may-newsletter.
has_webpage_versionstring- 1 to include a link to a web page version, 0 to leave it out. Example: 1.one of
10 inbox_preview_textstring- Preview text shown in the inbox. Example: What's new this month.
is_manual_textstring- 1 to use template_text as written, 0 to generate the text version from the HTML. Example: 0.one of
10 namestring- Internal name of the campaign. Example: May Newsletter.
reply_emailstring- Reply-to email address. Example: support@acme.com.
subjectstring- Subject line. Example: Our May update.
template_contentstring- HTML body of the email. Example: <html><body><h1>Hello</h1></body></html>.
template_textstring- Plain-text body of the email. Example: Hello.
versionstring- Editor version of the email: 1 for the classic editor, 2 for the drag-and-drop editor. Example: 1.one of
12
benchmarkemail_list_createCreate a contact list.WriteCreate Contact List
Create a contact list. Returns the new list in Response.Data, including its ID. Use benchmarkemail_contact_add to add contacts to it afterwards.
Inputs
namestringrequired- Name of the new list. Example: Spring Newsletter.
descriptionstring- Description of the list. Example: Subscribers from the spring campaign.
firstname_labelstring- Label shown for the First Name field. Example: First Name.
lastname_labelstring- Label shown for the Last Name field. Example: Last Name.
middlename_labelstring- Label shown for the Middle Name field. Example: Middle Name.
benchmarkemail_list_updateRename a contact list or change its description and name-field labels.WriteUpdate Contact List
Rename a contact list or change its description and name-field labels. Returns Response.Status and the updated list. Only the fields you pass change.
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
descriptionstring- New list description. Example: Updated description.
firstname_labelstring- New label for the First Name field. Example: First Name.
lastname_labelstring- New label for the Last Name field. Example: Last Name.
namestring- New list name. Example: Spring Newsletter 2026.
benchmarkemail_list_webhook_createCreate a webhook that notifies a URL about subscriber events on a contact list.WriteCreate List Webhook
Create a webhook that notifies a URL about subscriber events on a contact list. Returns the new webhook in Response.Data. Set each event flag to 1 to be notified of it or 0 to skip it.
Inputs
client_urlstringrequired- HTTPS URL Benchmark posts the events to. Example: https://example.com/hooks/benchmark.
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
cleaned_addressstring- 1 to be notified when an address is cleaned (bounced) from the list, 0 to skip. Example: 0.one of
10 contact_master_idstring- ID of the contact list; pass the same value as list_id. Example: 15981783.
email_changedstring- 1 to be notified when a contact's email changes, 0 to skip. Example: 0.one of
10 idstring- ID. Example: 8754321.
profile_updatesstring- 1 to be notified when a contact's profile fields change, 0 to skip. Example: 0.one of
10 subscribesstring- 1 to be notified of new subscribers, 0 to skip. Example: 1.one of
10 unsubscribesstring- 1 to be notified of unsubscribes, 0 to skip. Example: 1.one of
10
benchmarkemail_list_webhook_updateChange a contact-list webhook's URL or the events it reports.WriteUpdate List Webhook
Change a contact-list webhook's URL or the events it reports. Returns Response.Status. Use benchmarkemail_list_webhooks_list to find the webhook ID.
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
webhook_idstringrequired- ID of the webhook. Get it from benchmarkemail_list_webhooks_list. Example: 998877.
cleaned_addressstring- 1 to be notified when an address is cleaned (bounced) from the list, 0 to skip. Example: 0.one of
10 client_urlstring- HTTPS URL Benchmark posts the events to. Example: https://example.com/hooks/benchmark.
contact_master_idstring- ID of the contact list; pass the same value as list_id. Example: 15981783.
email_changedstring- 1 to be notified when a contact's email changes, 0 to skip. Example: 0.one of
10 profile_updatesstring- 1 to be notified when a contact's profile fields change, 0 to skip. Example: 0.one of
10 subscribesstring- 1 to be notified of new subscribers, 0 to skip. Example: 1.one of
10 unsubscribesstring- 1 to be notified of unsubscribes, 0 to skip. Example: 1.one of
10
benchmarkemail_automation_deleteDelete an automation and stop its emails.DestructiveDelete Automation
Delete an automation and stop its emails. Returns Response.Status.
- Idempotent
Inputs
automation_idstringrequired- ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.
benchmarkemail_contact_deleteDelete a contact from one contact list.DestructiveDelete Contact from List
Delete a contact from one contact list. Returns Response.Status. Use benchmarkemail_contact_unsubscribe to keep the contact but stop all email to it.
- Idempotent
Inputs
contact_idstringrequired- ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_contact_unsubscribeMove a contact to the account's Do Not Contact (master unsubscribe) list.DestructiveUnsubscribe Contact
Move a contact to the account's Do Not Contact (master unsubscribe) list. Returns Response.Status. Use it to stop all email to an address. Use benchmarkemail_contact_delete to only remove it from one list.
- Idempotent
Inputs
contact_idstringrequired- ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_email_deleteDelete an email campaign and move it to the trash.DestructiveDelete Email
Delete an email campaign and move it to the trash. Returns Response.Status.
- Idempotent
Inputs
email_idstringrequired- ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
benchmarkemail_list_deleteDelete a contact list and move it to the trash.DestructiveDelete Contact List
Delete a contact list and move it to the trash. Returns Response.Status. Use benchmarkemail_contact_delete to remove a single contact instead.
- Idempotent
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
benchmarkemail_list_webhook_deleteDelete a webhook from a contact list.DestructiveDelete List Webhook
Delete a webhook from a contact list. Returns Response.Status.
- Idempotent
Inputs
list_idstringrequired- ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
webhook_idstringrequired- ID of the webhook. Get it from benchmarkemail_list_webhooks_list. Example: 998877.
benchmarkemail_segment_deleteDelete a segment.DestructiveDelete Segment
Delete a segment. The contacts stay in their list. Returns Response.Status.
- Idempotent
Inputs
segment_idstringrequired- ID of the segment. Get it from benchmarkemail_segments_list. Example: 123456.
No tools match.