Team
Shared credential for production and unattended runs.
Connect Benchmark Email with Hookshot™ and your stack
Benchmark Email is a comprehensive email marketing platform offering tools for creating, sending, and analyzing email campaigns.
Tools and triggers
What Agents can do in Benchmark Email
Available tools and events after Benchmark Email is connected.
-
Add / Update Scheme
Tool to add or update a color scheme. Use when creating new schemes or modifying existing ones with color hex codes.
-
Add Contact to List
Tool to add a new contact to a specific list. Use after verifying the list ID exists.
-
Add Email in Automation
Tool to add an email to an automation workflow. Use when configuring automation sequences for email campaigns.
-
Add Email to Archive
Tool to add an email to the archive page. Use when you need to archive an email campaign by its ID.
-
Add Email to Community
Tool to add an email campaign to the public community with category and keywords. Use after creating an email campaign to publish it to the community platform.
-
Add/Remove Inbox Tests From Sub-Account
Tool to add or remove inbox tests from a sub-account. Use when you need to allocate or deallocate inbox testing credits for a child account.
-
Assign Product to List
Tool to assign a Shopify product to a list where purchasers are added. Use when integrating Shopify purchases with email lists.
-
Change Password
Tool to change the password for the client account. Use when updating account credentials after validating new and confirm passwords match.
-
Change Security PIN
Tool to change security PIN for the client account. Use after confirming your current PIN to rotate your PIN.
-
Check If Responsive
Tool to check if the client is responsive. Use when verifying client responsiveness status.
-
Clean Contact List
Tool to clean a contact list by removing invalid or bounced email addresses. Use when you need to improve list quality.
-
Compare Contacts
Tool to compare contacts across multiple contact lists. Use when you need to identify shared or unique contacts between lists.
-
Configure Shopify Purchase List
Tool to configure Shopify purchase list integration. Use when setting up or updating the contact list for Shopify purchase tracking.
-
Connect Third-Party Service
Tool to get the OAuth authorization URL for connecting a third-party e-commerce or CRM service. Use when integrating with ETSY, EBAY, SHOPIFY, or SALESFORCE.
-
Copy Bulk Contacts
Tool to copy multiple contacts in bulk to target lists. Use when you need to duplicate contacts across lists without moving them.
-
Copy Contacts
Tool to copy a contact to a specific list. Use when you need to duplicate a contact from one list to another.
-
Copy Email in Automation
Tool to create a copy of an automation email. Use when duplicating an email within an automation workflow.
-
Copy Existing Email
Tool to copy an existing email. Use when duplicating an email campaign by its ID. The copied email will have a new ID and the specified name.
-
Copy Image to Sub-Account
Tool to copy an image to one or more sub-accounts. Use when sharing an image with specific sub-accounts by providing comma-separated client IDs.
-
Copy Poll
Tool to copy an existing poll. Use when you need to duplicate a poll with a new name.
-
Copy Signup Form
Tool to copy an existing signup form. Use when you need to duplicate a signup form with a new name.
-
Create Automation Copy
Tool to create a copy of an existing automation. Use after confirming the automation ID to duplicate.
-
Create Contact List
Tool to create a new contact list. Use after planning list name and optional description.
-
Create Inbox
Tool to create a new inbox for email testing. Use when you need to set up an inbox for testing email campaigns.
-
Create Poll
Tool to create a new poll in Benchmark Email. Use when you need to create a poll for collecting responses.
-
Create Segment Criteria
Tool to create criteria for a segment. Use after confirming the segment ID exists and defining filter rules.
-
Create Segment From Contact IDs
Tool to create a segment from a list of contact IDs. Use after collecting contact IDs to group them into a segment.
-
Create Signup Form
Tool to create a new signup form for collecting email subscribers. Use when you need to set up a subscription form with associated contact lists.
-
Create Webhook
Tool to create a new webhook for a contact list. Use when you need to get callbacks for list events after list creation.
-
Delete a Poll
Tool to delete a poll by its ID. Use when removing a poll from the system.
-
Delete a Survey
Tool to delete a survey by its ID. Use when removing a survey from the system.
-
Delete AB Test Email
Tool to move an AB test email to trash. Use when removing an AB split test by its ID.
-
Delete ABSplit Campaign
Tool to delete an ABSplit campaign configuration from an email. Use when removing A/B split test settings from a campaign by its ID.
-
Delete Automation
Tool to delete an automation by its ID. Use when removing an automation workflow after confirming the automation ID is correct.
-
Delete Automation Email
Tool to delete an automation email from an automation workflow. Use when removing a specific email from an automation sequence by providing both the automation ID and automation email ID.
-
Delete Contact From All Lists by ID
Tool to delete a specific contact from all lists by list ID and contact ID. Use when you need to remove a contact globally from all lists using the contact details page.
-
Delete Contact From List
Tool to delete a contact from a specific list by ContactID. Use when you have list and contact IDs. Example: "Delete contact 2040826674 from list 15257899"
-
Delete Contact From Search
Tool to delete a contact from the search contact page. Use when you need to remove a contact by its ContactID directly from the search results.
-
Delete Contact List
Tool to delete a contact list. Use after confirming that the list is no longer in use.
-
Delete Contacts From All Lists
Tool to delete selected contacts from all lists. Use when you need to remove contacts globally across all lists, optionally filtered by search or filter criteria.
-
Delete Contacts From Current Lists
Tool to delete selected contacts from current lists. Use when you need to remove contacts from current lists, filtered by search or filter criteria.
-
Delete Email Campaign
Tool to delete an email campaign. Use when removing a campaign by its ID. Use after confirming the campaign ID is correct.
-
Delete Email From Archive
Tool to delete an email from the archive. Use when removing an archived email by its archive ID.
-
Delete Image
Tool to delete an image by its ID. Use when removing an image from the Benchmark Email account after confirming the image ID is correct.
-
Delete Inbox
Tool to delete an inbox by its ID. Use after confirming the inbox ID is correct.
-
Delete Linked Agency Account
Tool to delete a linked agency account. Use when revoking a linked agency account by its ID. Use after confirming the account ID is correct.
-
Delete List
Tool to delete one or more contact lists by their IDs. Use after confirming that the lists are no longer needed.
-
Delete Product Association
Tool to delete a Shopify product association from Benchmark Email. Use when removing a product integration between Shopify and Benchmark Email.
-
Delete Segment
Tool to delete a contact segment by its ID. Use after confirming the segment ID is correct.
-
Delete Segment Criteria
Tool to delete criteria from a segment. Use after confirming the segment ID exists.
-
Delete Trash List
Tool to delete all trash contacts from a list. Use when cleaning up trash contacts from a specific list.
-
Delete Video
Tool to delete one or more videos by their IDs. Use when removing videos from the Benchmark Email account after confirming the video IDs are correct.
-
Delete Webhook
Tool to delete a webhook from a contact list by its ID. Use when removing obsolete or invalid webhooks after confirming list and webhook details.
-
Disable Security PIN
Tool to disable security PIN for the client account. Use when revoking the current PIN to remove PIN protection.
-
Disconnect eBay Integration
Tool to disconnect the eBay integration from the authenticated account. Use when removing eBay integration or revoking eBay access.
-
Disconnect Etsy Integration
Tool to disconnect Etsy integration from the Benchmark Email account. Use when removing the connection between Benchmark Email and Etsy e-commerce platform.
-
Disconnect Eventbrite Integration
Tool to disconnect the Eventbrite integration from Benchmark Email account. Use when removing Eventbrite integration to stop syncing event attendees.
-
Disconnect Facebook Events
Tool to disconnect the Facebook Events integration from Benchmark Email. Use when removing the Facebook Events connection from the account.
-
Disconnect Facebook Integration
Tool to disconnect Facebook integration from Benchmark Email account. Use when revoking Facebook integration. Returns status 1 on success, -1 on error.
-
Disconnect Instagram Integration
Tool to disconnect the Instagram integration from Benchmark Email account. Use when revoking Instagram access or removing the Instagram connection.
-
Disconnect LinkedIn Integration
Tool to disconnect the LinkedIn integration from the Benchmark Email account. Use when removing LinkedIn social media integration.
-
Disconnect Pinterest Connection
Tool to disconnect the Pinterest integration from the Benchmark Email account. Use when removing Pinterest connection or revoking Pinterest access.
-
Disconnect Salesforce Integration
Tool to disconnect the Salesforce integration from Benchmark Email account. Use when revoking the Salesforce CRM connection.
-
Disconnect Shopify
Tool to disconnect Shopify integration from Benchmark Email. Use when removing the connection between Shopify and Benchmark Email accounts.
-
Disconnect Twitter Integration
Tool to disconnect Twitter integration from Benchmark Email account. Use when removing Twitter integration.
-
Download Contact Report
Tool to download contact list report. Use when you need to export or download contact data for a specific list.
-
Generate Support Ticket
Tool to generate a support ticket. Use when you need to create a help desk ticket for customer support or technical assistance.
-
Get a List of AB Tests
Tool to retrieve a list of AB tests with optional filtering and pagination. Use when you need to list or search AB test campaigns.
-
Get a List of Images
Tool to retrieve a list of images. Use when you need to list or search images from the account.
-
Get AB Split Details
Tool to get details for an AB split test by email ID. Use when you need to retrieve A/B test configuration and status for a specific email campaign.
-
Get AB Split Results
Tool to get the results for an AB split test. Use when retrieving performance metrics and outcomes of A/B test campaigns.
-
Get AB Test Report
Tool to retrieve AB split test reports with pagination. Use when you need to fetch A/B test campaign results.
-
Get Abuse Campaign Report by Email ID
Tool to get abuse campaign report for an email by ID. Use when you need to retrieve abuse report data for a specific email campaign.
-
Get Abuse Report
Tool to get abuse report containing statistics about email abuse complaints. Use when you need to review abuse complaint metrics and rates.
-
Get Account Summary
Tool to get account summary including plan type and image storage limit. Use when checking available image storage space.
-
Get Active Contact Count
Tool to get the total count of all active contacts/emails in the account. Use when you need to retrieve the active contact count.
-
Get All Confirmed Emails
Tool to retrieve all confirmed email addresses for the client account. Use after user completes email confirmation flows to fetch final list.
-
Get Archive Domain Name
Tool to get the archive domain name for the client. Use when you need to retrieve the configured domain name for email archives.
-
Get Archive Email Details
Tool to get details of an archived email by its ArchiveID. Use when you need to retrieve information about a specific archived email.
-
Get Archive Emails
Tool to retrieve a list of emails from the archive. Use when you need to list or search archived emails.
-
Get Archive Home Data
Tool to get archive home data for a specific domain and type. Use when retrieving details of an archived email by its domain identifier.
-
Get Archive Home Page
Tool to get the archive home page containing archive entries. Use when retrieving archive listing or home page data.
-
Get Archive Pages
Tool to retrieve list of archive pages. Use when you need to view or list all archive pages in the account.
-
Get Automation Details
Tool to get details of an automation by its ID. Use when you need to retrieve information about a specific automation workflow.
-
Get Automation Email Details
Tool to get details for an automation email. Use when retrieving configuration and settings of a specific email in an automation workflow.
-
Get Automation Summary Report
Tool to get summary report of an automation by ID. Use when you need to retrieve performance metrics and statistics for a specific automation workflow.
-
Get Badges List
Tool to retrieve all available email badges. Use when you need to list or view badge information.
-
Get Bounces Report by Email ID
Tool to get bounces report for an email campaign by ID. Use when you need to retrieve information about bounced emails for a specific email campaign.
-
Get Campaign Engagement List
Tool to retrieve campaign engagement statistics. Use when you need to analyze campaign performance metrics including opens, clicks, bounces, and unsubscribes.
-
Get Campaign History by Email ID
Tool to get campaign history for an email by ID. Use when you need to retrieve historical campaign data for a specific email.
-
Get Click Contact Count
Tool to get click contact count for email campaigns. Use when you need to retrieve the count of contacts who clicked on emails.
-
Get Click HeatMap by Email ID
Tool to get click heatmap report for an email by ID. Use when you need to analyze the click patterns and visualize which links in an email campaign received the most engagement.
-
Get Click Performance by Email ID
Tool to get click performance report for an email by ID. Use when you need to retrieve click performance metrics for a specific email campaign.
-
Get Click Performance Details by Email
Tool to get click performance details for an email campaign by ID. Use when you need detailed click tracking data including who clicked, when, and which links were clicked.
-
Get Click URL Contact Count
Tool to get click URL contact count of engagement metrics. Use when you need to retrieve engagement statistics for campaign URLs.
-
Get Clicks Report by Email ID
Tool to get clicks report for an email by ID. Use when you need to retrieve the list of contacts who clicked links in a specific email campaign.
-
Get Client Account Settings
Tool to get client account settings such as company, language, timezone, and sender info. Use when you need to fetch account configuration before sending campaigns.
-
Get Client Details
Tool to get client details including profile data, contact count, and plan information. Use when verifying account profile and limits.
-
Get Client Filter Domain
Tool to get client filter domains. Use when you need to retrieve the list of whitelisted domains.
-
Get Client Plan Information
Tool to get client's plan information including addons, email plan, and total contacts. Use when you need the current plan details before managing upgrades or billing.
-
Get Client Profile Details
Tool to get client's profile details like business city, country, phone, and company. Use after confirming authentication to fetch client profile info.
-
Get Clients Rating Range
Tool to get clients rating range including min, max, and current rating values. Use when you need to retrieve rating information for the authenticated client.
-
Get Commission List
Tool to get the partner commission list. Use when you need to retrieve commission information for partners.
-
Get Community Category
Tool to retrieve a list of available community categories. Use when you need to get available category options before adding an email to the community.
-
Get Community Domain
Tool to get the community domain name for the client. Use when you need to retrieve the configured domain for the community.
-
Get Community Email by ID
Tool to get details of a community email by ID. Use when you need to retrieve information about a specific community email.
-
Get Contact Audit History
Tool to retrieve audit history for contacts in a specific list. Use when you need to track changes and actions performed on contacts.
-
Get Contact Audit History Detail
Tool to get detailed audit history for a specific batch and group of contact changes. Use after getting BatchID and GroupID from the audit history endpoint to retrieve detailed information about contact modifications.
-
Get Contact Details
Tool to retrieve detailed information for a specific contact including custom field values and rating. Use when you need complete contact details from a list.
-
Get Contact Import Status
Tool to get the status of contact import operations. Use when you need to check the progress or results of a contact import.
-
Get Contact List Deep View
Tool to fetch deep view of contact list(s) including all fields and field types. Use when you need comprehensive list metadata and structure information.
-
Get Contact List Details
Tool to fetch detailed information for a contact list. Use after confirming the list ID to retrieve all metadata.
-
Get Contact List Field Names
Tool to retrieve field names and attributes for a contact list. Use when you need to get available fields for a specific list.
-
Get Contact List Summary
Tool to get summary details and performance metrics of a contact list. Use when you need to retrieve statistics and counts for a specific contact list.
-
Get Contact Lists
Tool to retrieve all contact lists. Use when you need to list or select a contact list.
-
Get Contact Lists for Shopify
Tool to get Shopify integration contact lists and configuration. Use when retrieving Shopify integration settings or verifying connected contact lists for Shopify.
-
Get Contact Merge List
Tool to retrieve a list of contact lists that can be merged with a specified list. Use when you need to find compatible lists for merging contacts.
-
Get Contact Report History
Tool to get engagement history for a specific contact by email address. Use when you need to review which campaigns a contact has interacted with and their engagement metrics.
-
Get Contacts Count
Tool to get the count of contacts in specified lists and segments. Use when you need to know how many contacts exist in particular lists or segments without retrieving the full contact data.
-
Get Current Email at Time of Reset
Tool to get the current email address at the time of a reset request. Use when verifying the email associated with a password reset or email change operation.
-
Get Delete List Check
Tool to check if contact lists can be deleted. Use before attempting to delete lists to verify deletion eligibility.
-
Get Details About Archive Page
Tool to get details about the archive page including URLs, share settings, and domain. Use when you need to retrieve archive page configuration and URLs.
-
Get Details of Poll
Tool to retrieve details of a specific poll by ID. Use when you need information about a poll including its question, embed code, and share links.
-
Get Digioh Username
Tool to get Digioh username for the authenticated account. Use when checking Digioh integration status or retrieving the associated username.
-
Get DMARC List
Tool to retrieve DMARC (Domain-based Message Authentication, Reporting & Conformance) list for the client account. Use when you need to view domain authentication records.
-
Get Download Report
Tool to get download report for a contact list. Use when you need to retrieve the download URL or status for a specific contact list.
-
Get Download Segment Data
Tool to retrieve segment data for download. Use when you need to export or download contact data from a specific segment.
-
Get eBay Seller ID
Tool to get the eBay Seller ID for the authenticated account. Use when retrieving eBay integration details or verifying eBay connection status.
-
Get eBay Site List
Tool to retrieve a list of available eBay sites for integration. Use when you need to get eBay site options for connecting eBay accounts.
-
Get Email Campaign Details
Tool to get details for a specific email campaign by ID. Use when needing campaign information such as subject, sender, schedule, and contact lists.
-
Get Email Opens by Country and Region
Tool to get a list of contacts who opened an email from a specific country and region. Use when you need geographic engagement data for email campaigns.
-
Get Email Preview
Tool to get the preview of an email campaign. Use when you need to view the email content before sending.
-
Get Email Recipient Count
Tool to get the recipient count for an email campaign. Use when you need to know how many contacts will receive or have received a specific email campaign.
-
Get Email Report
Tool to get email reports with pagination and filtering options. Use when you need to retrieve a list of email campaign reports.
-
Get Email Report Forwards
Tool to get forwards report for an email campaign. Use after campaign send to export its forwards.
-
Get Email Spam Check
Tool to check spam score for an email campaign by ID. Use when you need to verify if an email campaign passes spam filters before sending.
-
Get Email Templates
Tool to retrieve email templates from Benchmark Email. Use when you need to list or select an email template for campaigns.
-
Get Etsy Store Name
Tool to get the connected Etsy store name. Use when verifying Etsy integration status or retrieving store details.
-
Get Eventbrite Username
Tool to get the Eventbrite username associated with the Benchmark Email account. Use when verifying Eventbrite integration status or retrieving connected username.
-
Get Facebook Account Holder
Tool to get Facebook account holder information. Use when you need to retrieve details about the connected Facebook account.
-
Get Facebook Account Name
Tool to get the Facebook account name from Facebook Events integration. Use when retrieving the connected Facebook account information.
-
Get Filtered Contacts in List
Tool to fetch filtered and paginated contacts from a list by ListID. Use when narrowing a list via search, filters, and paging.
-
Get Filtered Contacts with Extra Fields
Tool to fetch filtered and paginated contacts with custom/extra fields from a list by ListID. Use when you need contact data including custom field values along with standard contact information.
-
Get Forwards Report by Email ID
Tool to get forwards report for an email campaign by ID. Use when you need to retrieve the list of contacts who forwarded a specific email.
-
Get Full Report of Survey
Tool to retrieve the full report of a survey including all responses and answers. Use when you need to analyze survey results and response data.
-
Get HTML for Archive Newsletter
Tool to get HTML content for an archive newsletter by domain and URL. Use when you need to retrieve the HTML content of an archived email campaign.
-
Get HTML for Button
Tool to get HTML content for a button URL from the archive. Use when you need to retrieve the HTML markup for a specific button by its ID.
-
Get HTML Signup Form
Tool to retrieve HTML and JavaScript embed code for a Tumbler signup form. Use when you need to get the complete embed code including jQuery dependencies and colorbox popup functionality for newsletter signup…
-
Get Image Details
Tool to get details of a specific image by its ID. Use when retrieving information about a single image including its URL, size, and dates.
-
Get Image for Button
Tool to get HTML code for an 'Image' style archive button. This returns a pre-defined HTML snippet with an embedded image button for newsletter archive access. Similar to GetHtmlForButton but specifically returns the…
-
Get Inbox Detail Result
Tool to get inbox detail test statistics including total purchases, tests used, and remaining balance. Use when you need to check inbox testing capacity and usage.
-
Get Inbox List
Tool to retrieve inbox list with optional filtering and pagination. Use when you need to list or search inbox entries.
-
Get Inbox Master Result
Tool to get Inbox Master Result by ID. Use when retrieving inbox information for a specific inbox identifier.
-
Get Individual Question Result Detail in Survey
Tool to get individual question result details for a specific respondent in a survey by email address. Use when retrieving detailed survey response data for a single participant.
-
Get Integration Authorization URL
Tool to get the OAuth authorization URL for integrating with third-party platforms. Use when setting up integrations with services like SurveyMonkey, EventBrite, Instagram, Facebook, or Twitter.
-
Get Integration Connection List
Tool to retrieve the list of editor integration connections. Use when you need to view or list connected integrations.
-
Get Layout List
Tool to retrieve a list of email layouts. Use when you need to list or select a layout for email campaigns.
-
Get Link Detail by Email ID
Tool to get link detail report for an email campaign by ID. Use when you need to retrieve detailed link click statistics for a specific email campaign.
-
Get Linked Agency Account Details
Tool to get details of a linked agency account. Use when retrieving info for a specific linked account by ID after confirming the account exists.
-
Get Linked Agency Accounts
Tool to get list of linked agency accounts. Use after linking agency accounts to retrieve all associated accounts.
-
Get LinkedIn Token
Tool to get LinkedIn integration token information. Use when checking LinkedIn connection status or retrieving LinkedIn token details.
-
Get List Mapping
Tool to get the field mapping of an uploaded contact list file. Use when you need to retrieve how the uploaded file fields are mapped to Benchmark Email list fields.
-
Get List of Confirmed Emails
Tool to retrieve a list of confirmed email addresses for the client account. Use when you need a simple list of confirmed emails without detailed metadata.
-
Get List of Emails
Tool to retrieve all email campaigns with optional filters and pagination. Use when you need to list, search, or select an email campaign.
-
Get List of Giphy Images
Tool to retrieve a list of Giphy images. Use when you need to list or search Giphy images available in the account.
-
Get List of Help Topics
Tool to retrieve help topics from Benchmark Email. Use when you need to browse or search available help resources.
-
Get List of Polls
Tool to retrieve a list of polls. Use when you need to list or search polls from the account.
-
Get List of Shopify Products
Tool to get a list of Shopify products in HTML format. Use when you need to retrieve Shopify product data for integration purposes.
-
Get List Upload Terms
Tool to get list upload terms from Benchmark Email. Use when retrieving terms and conditions for list uploads.
-
Get Magento HTML Dropdown
Tool to get Magento signup form dropdown HTML. Use when integrating Magento with email marketing campaigns.
-
Get Magento HTML Selected
Tool to retrieve Magento HTML code for a selected signup form. Use when you need to get the HTML and JavaScript code to integrate a Benchmark Email signup form with a Magento store's newsletter subscription.
-
Get Non Contact Count
Tool to get the count of non-contacts based on email IDs and filter criteria. Use when you need to count recipients who are not in the contact list for specific campaigns.
-
Get Notification
Tool to get client notifications from Benchmark Email. Use when checking for account alerts or messages.
-
Get Open Contact Count
Tool to get the count of contacts who opened specified email campaigns. Use when you need to retrieve engagement metrics for email campaigns by counting unique contacts who opened one or more emails.
-
Get Opens Hourly Report by Email
Tool to get hourly opens report for an email campaign by ID. Use when you need to analyze the hour-by-hour pattern of email opens for a specific campaign.
-
Get Opens Location Report
Tool to get a list of contacts by location for an email campaign's opens. Use when you need geographic distribution data of email opens.
-
Get Opens Location Report by Email
Tool to get a list of contacts who opened an email from a specific country. Use when you need geographic engagement data for email campaigns by country.
-
Get Opens Report
Tool to get opens report for an email campaign by ID. Use when you need to retrieve information about contacts who opened a specific email campaign.
-
Get Partner Profile Details
Tool to get partner profile details including company information and payment settings. Use when you need to fetch partner account configuration and payment preferences.
-
Get PayPal Contact Lists
Tool to get contact lists formatted for PayPal integration. Returns HTML select dropdown with available contact lists.
-
Get PayPal Integration Link
Tool to retrieve the PayPal integration callback URL for a specific contact list. Use when you need to get the PayPal integration link for a list.
-
Get Pinterest Username
Tool to retrieve the Pinterest username associated with the Benchmark Email account. Use when checking Pinterest integration status or fetching connected Pinterest username.
-
Get Poll Response Report
Tool to retrieve the response report of a poll by ID. Use when you need to analyze poll results and response data.
-
Get Preview of a Poll
Tool to get a preview/render of a poll by its ID. Use when you need to see how a poll will appear.
-
Get Referrals Level 1 List
Tool to get level 1 referrals list for a specific month and year. Use when you need to retrieve partner referral data.
-
Get Referrals List
Tool to retrieve the list of partner referrals. Use when you need to view referral information for commission tracking.
-
Get Report Answer Comment in Survey
Tool to retrieve comment answers from a survey report for a specific question. Use when analyzing open-ended or comment-type responses from survey participants.
-
Get Report Answer Other in Survey
Tool to retrieve 'other' text answers from survey questions that have an 'other' option. Use when you need to analyze free-text responses that don't fit predefined answer choices.
-
Get Report Answer Text in Survey
Tool to retrieve text answers from survey questions. Use when you need to analyze free-text responses to survey questions.
-
Get Report Details by AB Test
Tool to get report details for a specific AB split test by ID and ABID. Use when you need to retrieve detailed metrics and statistics for a particular A/B test campaign.
-
Get Report Details by Email ID
Tool to get detailed report summary for an email campaign by ID. Use when you need to review performance metrics like opens, clicks, bounces, and unsubscribes for a specific email campaign.
-
Get Report Download
Tool to download email campaign report by type. Use when you need to export clicks, forwards, bounces, complaints, or unsubscribe data for a specific email campaign.
-
Get Report List of Survey
Tool to retrieve a paginated list of survey reports. Use when you need to view or analyze survey report data across multiple surveys.
-
Get Report of Survey Individual Result
Tool to retrieve paginated individual survey results showing who responded and when. Use when you need to list all survey participants and their response metadata.
-
Get Reports for Autoresponders
Tool to get reports for autoresponders with pagination and filtering options. Use when you need to retrieve automation campaign reports or analyze autoresponder performance.
-
Get RSS History by Email ID
Tool to get RSS history for an email campaign by ID. Use when you need to retrieve RSS feed history for a specific email campaign.
-
Get Salesforce Integration Status
Tool to get Salesforce integration status and details from Benchmark Email account. Use when checking if Salesforce CRM is connected.
-
Get Save as List
Tool to retrieve save-as-list data with optional filters. Use when you need to query lists that were saved from email campaigns, events, or AB tests.
-
Get Scheme
Tool to retrieve color schemes with optional filtering. Use when fetching default or saved color schemes for email templates.
-
Get Segment Auto Generate Name
Tool to get an auto-generated segment name for a list. Use when creating segments to get a default name suggestion.
-
Get Segment by ID
Tool to retrieve details of a specific contact segment by its ID. Use when you need to get information about a particular segment.
-
Get Segment Details
Tool to retrieve contact details from a specific segment with optional filtering, pagination, and sorting. Use when you need to access the contacts within a segment.
-
Get Segment List
Tool to retrieve segment lists for a specific contact list by ListID. Use when you need to get all segments associated with a particular contact list.
-
Get Segments
Tool to retrieve a paginated list of contact segments. Use when you need to list or find segments with optional filtering and sorting.
-
Get Shopify Product List Tabular
Tool to get Shopify product list in tabular (HTML) format. Use when you need to retrieve product data from a Shopify integration.
-
Get Signup Form Button Code
Tool to get the code for the signup form button. Use when you need to retrieve the HTML/JavaScript code snippet for embedding a signup form button on a website.
-
Get Signup Form Contact Fields
Tool to get the contact fields of a signup form by ID. Use when you need to retrieve the list of contact fields configured for a specific signup form.
-
Get Signup Form Details
Tool to get details for a specific signup form by ID. Use when needing information about a signup form's configuration and associated contact lists.
-
Get Signup Form Link
Tool to get the link URL for a specific signup form. Use when needing the public URL for a signup form to share or embed.
-
Get Signup Form List
Tool to retrieve all signup forms (listbuilder forms). Use when you need to list available signup forms for the account.
-
Get Signup Forms for Contact List
Tool to get a list of signup forms associated with a specific contact list. Use when needing to identify which signup forms feed into a particular contact list.
-
Get SignupForm for Magento
Tool to get SignupForm data for Magento integration. Use when you need to retrieve signup form configuration for integrating with a Magento store.
-
Get SignupForm for Unbounce
Tool to retrieve signup form integration data for Unbounce. Use when you need to get the Unbounce integration URL or configuration for a specific contact master ID.
-
Get SignupForm Tumbler
Tool to get third-party SignupForm Tumbler query string parameters. Use when you need to retrieve Tumbler integration parameters for a signup form.
-
Get Social Performance Report
Tool to get social performance report for an email campaign by ID. Use when you need to retrieve social sharing metrics and statistics for a specific email campaign.
-
Get Sub-Account Balance
Tool to get the balance (plan limit) for a specific sub-account by ID. Use when needing to check the contact limit or plan balance of a child account.
-
Get Sub-Account Details
Tool to get details for a specific sub-account by ID. Use when needing profile and plan info of a child account.
-
Get Sub-Account History
Tool to get sub-account history. Use after listing sub-accounts to retrieve each account's billing history.
-
Get Sub-Account History Details
Tool to get detailed history information for a specific sub-account billing cycle. Use when you need billing cycle details for a particular history record.
-
Get Sub-Accounts
Tool to retrieve all sub-accounts for the client. Use when you need to view or manage sub-accounts.
-
Get Sub-Accounts Plan List
Tool to retrieve available plans for a sub-account. Use when you need to determine list and email limits for a specific sub-account client ID.
-
Get Survey Details
Tool to retrieve details of a specific survey by ID. Use when you need information about a survey including its questions and metadata.
-
Get Survey Report Detail
Tool to get detailed report of a survey including questions, responses, and response counts. Use when needing survey analytics and response data.
-
Get Template by Template ID
Tool to get details for a specific email template by ID. Use when needing template information such as name, subject, content, and metadata.
-
Get Template Category by ID
Tool to get details for a specific email template category by ID. Use when needing information about a template category.
-
Get Template Category List
Tool to retrieve template category list with optional filters. Use when you need to browse or select email template categories.
-
Get Template List of Survey
Tool to retrieve the list of survey templates. Use when you need to view available survey templates.
-
Get Templates for Signup Form Classic
Tool to retrieve templates for Signup Forms (Classic Only). Use when you need to list available signup form templates for the classic editor.
-
Get the Clean Count
Tool to get the clean count for a contact list. Use when you need to retrieve clean count statistics for a specific list.
-
Get Trash Count
Tool to get the count of contacts in the trash. Use when you need to retrieve the number of deleted contacts.
-
Get Tumbler Lists
Tool to get Tumbler signup form lists in HTML format. Use when you need to retrieve the list of signup forms for Tumbler integration.
-
Get Twitter Login Status
Tool to get Twitter login/integration status for the authenticated Benchmark Email account. Use when checking if Twitter is connected or retrieving Twitter account details.
-
Get Unbounce Link
Tool to get the Unbounce integration URL for a specific contact list. Use when you need to retrieve the Unbounce URL for integrating a contact list with Unbounce landing pages.
-
Get Unbounce Lists
Tool to get Unbounce contact lists in HTML format. Use when integrating with Unbounce to retrieve available signup form lists.
-
Get Unique Contact Count
Tool to get the total count of unique contacts in the account. Use when needing the unique contact count.
-
Get Unopens Report by Email ID
Tool to get unopens report for an email campaign by ID. Use when you need to retrieve a list of contacts who did not open a specific email campaign.
-
Get Unsubscribe Report by Email ID
Tool to get unsubscribe report for an email campaign by ID. Use when you need to review recipients who unsubscribed from a specific email campaign.
-
Get URL Engagement List
Tool to retrieve URL engagement statistics for email campaigns. Use when you need to analyze which URLs in your emails were clicked and their engagement metrics.
-
Get URL List by Email ID
Tool to get URL list for a specific email campaign by ID. Use when you need to retrieve all URLs included in an email campaign.
-
Get Video Details
Tool to get details for a specific video by its ID. Use when needing information about a video in the Benchmark Email account.
-
Get Web Page Ads Detail
Tool to get web page ads detail from the Partner API. Use when you need to retrieve information about web page advertisements.
-
Get Webhooks
Tool to retrieve all webhooks for a contact list. Use when you need to view or list webhooks configured for a specific list.
-
Initiate Email Screen Capture
Tool to initiate the screen capture process for an email campaign. Use when you need to generate a screen capture of a specific email by its ID.
-
Link Agency Account
Tool to link an agency account to your Benchmark Email account. Use when you need to connect and manage another account with the provided credentials.
-
Log Out Twitter Tweets
Tool to log out of Twitter Tweets integration from Benchmark Email account. Use when removing Twitter Tweets posting integration.
-
Login Redirect Using Token
Tool to acquire a temporary token to an account. Use when you need to authenticate and get redirected to a specific path in the application using a token-based login.
-
Merge Contacts Into Existing List
Tool to merge contacts from source list(s) into an existing target list. Use when you need to consolidate contacts from one or more lists into another list.
-
Merge Contacts Into New List
Tool to merge contacts from multiple lists into a new list. Use when you need to consolidate contacts from different lists into a single new list.
-
Move Bulk Contacts
Tool to move contacts in bulk from a source list to one or more target lists. Use when you need to transfer contacts between lists, removing them from the source.
-
Move Contact to Do Not Contact List
Tool to move a contact to the Do Not Contact (Master Unsubscribe) list. Use when you need to permanently unsubscribe a contact from all communications.
-
Move Contacts
Tool to move contacts from one list to another. Use when you need to relocate contacts between lists.
-
Patch Update Client Settings
Tool to update client account settings. Use after fetching current settings. Updates company info, timezone, language, sender defaults, and signature details.
-
Permanently Delete Email From Trash
Tool to permanently delete an email from trash. Use when permanently removing a trashed email by its ID. This action cannot be undone.
-
Resend Confirm Email
Tool to resend confirmation email to a specific email address. Use when an email address needs to receive a new confirmation link.
-
Resend Emails to Contacts
Tool to resend confirmation emails to contacts in a specific list. Use when you need to resend verification or confirmation emails to contacts.
-
Restore Email From Trash
Tool to restore an email from trash. Use when you need to recover a deleted email campaign by moving it out of trash.
-
Restore Trash List
Tool to restore deleted contact lists from trash. Use after confirming the list IDs to recover.
-
Save Email Address
Tool to save email address(es) to a contact list in CSV format. Use when you need to add or update email addresses in a specific list.
-
Save Security PIN
Tool to save a new security PIN for the client account. Use when you need to update the account PIN after confirming both entries match.
-
Save Verified Email Addresses
Tool to save email addresses which have verified URLs to a contact list. Use when you need to mark specific email addresses as verified in a list.
-
Save Website Domain
Tool to save a website domain for your Benchmark Email account. Use after account setup to register your domain for link tracking.
-
Schedule Email Campaign
Tool to schedule an email campaign for sending at a specific date and time. Use when you need to schedule a verified email campaign for future delivery.
-
Search Contact Details by Email
Tool to search for contact details by email address and show lists they belong to and status. Use when you need to find a contact's membership information across lists.
-
Send Confirm Email Verification
Tool to send confirm email verification. Use when unverified addresses must receive verification emails after signup.
-
Send PIN via Email
Tool to send PIN via email. Use when you forgot your security PIN and need it emailed to you.
-
Send Reset Email
Tool to send a reset email link to change the primary email address. Use when initiating an email-based reset of the account’s primary email after user request.
-
Send Support Feedback
Tool to send support feedback or inquiry to Benchmark Email support team. Use when users need to contact support with questions, issues, or feedback.
-
Send Test Email for Signup Form
Tool to send a test email for a signup form. Use when you need to test the signup form email configuration before going live.
-
Set Responsive
Tool to set the client's responsive status. Use when enabling or disabling responsive mode for the client account.
-
Share Lists with SubAccounts
Tool to share contact lists with sub-accounts. Use when you need to grant sub-accounts access to a specific list.
-
Share Template to Sub-Accounts
Tool to share an email template with sub-accounts. Use when distributing templates across sub-accounts.
-
Share Video
Tool to share/copy a video to other client accounts. Use when you need to duplicate a video across multiple client accounts.
-
Test eBay Integration
Tool to test eBay integration and verify connection status. Use when validating eBay account connectivity and retrieving integration details.
-
Test Etsy Integration
Tool to test the Etsy integration connection with Benchmark Email. Use when verifying if the Etsy integration is properly configured and working.
-
Test Eventbrite Integration
Tool to test the Eventbrite integration connection with Benchmark Email. Use when verifying if Eventbrite is properly connected and syncing.
-
Test Facebook Events Integration
Tool to test Facebook Events integration in Benchmark Email. Use when verifying the Facebook Events connection is working properly.
-
Test Facebook Integration
Tool to test Facebook integration status for the Benchmark Email account. Use when verifying Facebook connection. Returns status 1 on success, -1 on error, with an HTML-formatted message describing the result.
-
Test LinkedIn Connection
Tool to test the LinkedIn integration connection status. Use when verifying if LinkedIn is properly connected to the Benchmark Email account.
-
Test Pinterest Integration
Tool to test the Pinterest integration connection for the Benchmark Email account. Use when verifying Pinterest integration status or troubleshooting connection issues.
-
Test Salesforce Integration
Tool to test the Salesforce integration connection. Use when verifying that Salesforce CRM is properly connected and accessible.
-
Test Twitter Integration
Tool to test the Twitter/X integration connection. Use when verifying that Twitter (X) is properly connected and accessible.
-
Test Twitter Tweets
Tool to test Twitter tweets integration and retrieve follower information. Use to verify Twitter connection and get follower statistics in HTML format.
-
Update Archive Home Page
Tool to add an email to the archive home page with a specific view order. Use when you need to feature an archived email on the archive home page.
-
Update Archive Home Page Data
Tool to update archive home page data like page title, logo, header, and footer. Use when modifying the appearance or content of the archive home page.
-
Update Contact Details
Tool to update contact details in a specific list. Use when you need to modify a contact's email, name, or rating.
-
Update Contact List
Tool to update an existing contact list. Use after confirming list ID and desired modifications to name, description, labels, or custom fields.
-
Update Email Campaign
Tool to update an existing email campaign. Use to modify campaign properties such as name, subject, sender name, sender email, or reply-to address.
-
Update Email Content for Automation
Tool to update email content for an automation workflow. Use when modifying the subject, template content, or sender details of an existing automation email.
-
Update Linked Agency Account
Tool to update a linked agency account. Use when modifying login credentials or alias for an existing linked account by its ID.
-
Update List Compilation Details
Tool to update the compilation details for a contact list file upload. Use when changing the file upload compilation URL after uploading contacts to a list.
-
Update Partner Profile
Tool to update partner profile details including company name, email, phone, and PayPal email. Use when you need to modify partner account information. PayPalEmail is required.
-
Update Poll
Tool to update an existing poll in Benchmark Email. Use when you need to modify a poll's name or question.
-
Update Segment
Tool to update an existing contact segment. Use when you need to modify a segment's name, description, or associated list ID.
-
Update Survey Status
Tool to update the status of a survey. Use when activating, deactivating, or removing a survey.
-
Update Webhook
Tool to update a webhook for a contact list by webhook ID. Use after retrieving or creating a webhook to modify its event settings such as cleaned-address, email-change, profile-update, subscribe, and unsubscribe…
-
Update/Edit Profile
Tool to update or edit profile information such as first name, last name, and phone number. Use after retrieving profile details to apply changes.
-
Update/Reset Email
Tool to reset the primary email address using a GUID from the reset email link. Use when completing the email change process after the reset link has been sent.
-
Upload Video
Tool to upload a video via URL. Use when adding videos from external sources (YouTube, Vimeo, etc.) to the Benchmark Email account.
Setup
Connect Benchmark Email in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
