Skip to main content
Benchmark Email logo
  • Category: email newsletters
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 298
  • Triggers: 0
  • Slug: BENCHMARK_EMAIL
  • Version: 20261101_00

Tools

Slug: BENCHMARK_EMAIL_ADD_EMAIL_IN_AUTOMATIONTool to add an email to an automation workflow. Use when configuring automation sequences for email campaigns.

Input Parameters

string
Number of days for scheduling the automation email
string
Contact list ID associated with the automation
string
Email template ID to use for the automation
string
Email subject line
string
Preview text displayed before opening the email
Link that triggers the automation
string
Type of trigger for the automation email
string
required
ID of the automation workflow to add the email to
string
Field that triggers the automation
string
ID of the email that triggers this automation
string
Google Analytics campaign name for tracking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_ADD_EMAIL_TO_ARCHIVETool to add an email to the archive page. Use when you need to archive an email campaign by its ID.

Input Parameters

string
required
ID of the email to add to archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_ADD_EMAIL_TO_COMMUNITYTool 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.

Input Parameters

string
required
ID of the email campaign to add to community
string
Comma-separated keyword tags for categorization
string
required
Category for the email in the public community

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_ADD_REMOVE_INBOX_TESTS_FROM_SUB_ACCOUNTTool 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.

Input Parameters

string
required
Sub-Account holder Client ID
integer
required
Number of inbox tests to add/remove. Positive values add tests, negative values remove tests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_CHECK_IF_RESPONSIVETool to check if the client is responsive. Use when verifying client responsiveness status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_CLEAN_CONTACT_LISTTool to clean a contact list by removing invalid or bounced email addresses. Use when you need to improve list quality.

Input Parameters

string
required
ID of the contact list to be cleaned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_COMPARE_CONTACTSRequest a comparison of contacts across multiple contact lists. The response reports the operation status, not the shared or unique contacts.

Input Parameters

string
required
Comma-separated list IDs to compare (e.g., ‘1,2’ or ‘15242968,15242969’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_CONNECT_SERVICETool 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.

Input Parameters

string ("ETSY" | "EBAY" | "SHOPIFY" | "SALESFORCE")
required
The third-party authentication site to connect to (ETSY, EBAY, SHOPIFY, or SALESFORCE)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_COPY_BULK_CONTACTSTool to copy multiple contacts in bulk to target lists. Use when you need to duplicate contacts across lists without moving them.

Input Parameters

string
required
Comma separated list of Contact IDs to copy
string
required
Target List ID where contacts will be copied to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_COPY_CONTACTSTool to copy a contact to a specific list. Use when you need to duplicate a contact from one list to another.

Input Parameters

string
required
ID of the list to copy the contact to
string
required
ID of the contact to copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_COPY_EMAIL_IN_AUTOMATIONTool to create a copy of an automation email. Use when duplicating an email within an automation workflow.

Input Parameters

string
required
Automation ID where the email exists
string
required
Automation email ID to copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_COPY_EXISTING_EMAILTool 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.

Input Parameters

string
required
ID of the email to copy
string
required
Name for the copied email

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_COPY_IMAGE_TO_SUB_ACCOUNTTool 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.

Input Parameters

string
required
Comma-separated list of sub-account/client IDs to copy the image to (e.g., ‘client1,client2’). Can be empty string to copy to all sub-accounts.
string
required
Unique identifier of the image to copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_COPY_SIGNUP_FORMTool to copy an existing signup form. Use when you need to duplicate a signup form with a new name.

Input Parameters

string
required
ID of the signup form to copy
string
required
Name of the copied signup form

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_CREATE_AUTOMATION_COPYTool to create a copy of an existing automation. Use after confirming the automation ID to duplicate.

Input Parameters

string
required
Name for the copied automation
string
required
ID of the automation to copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_CREATE_INBOXTool to create a new inbox for email testing. Use when you need to set up an inbox for testing email campaigns.

Input Parameters

string
required
Test ID (ID of the application in which the test is required)
string
required
Email ID for the inbox

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_CREATE_SEGMENT_FROM_CONTACT_IDSTool to create a segment from a list of contact IDs. Use after collecting contact IDs to group them into a segment.

Input Parameters

string
required
ID of the contact list where the segment will be created
array
required
Array of contact IDs to include in the segment. Must contain at least one contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_CREATE_SIGNUP_FORMTool to create a new signup form for collecting email subscribers. Use when you need to set up a subscription form with associated contact lists.

Input Parameters

string
required
Name of the signup form
array
required
List of contact lists to associate with the signup form. Each list requires ID and Name fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_ABSPLIT_CAMPAIGNTool to delete an ABSplit campaign configuration from an email. Use when removing A/B split test settings from a campaign by its ID.

Input Parameters

string
required
ID of the email campaign whose ABSplit to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_AB_TEST_EMAILTool to move an AB test email to trash. Use when removing an AB split test by its ID.

Input Parameters

string
required
The unique identifier of the AB split test email to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_A_POLLTool to delete a poll by its ID. Use when removing a poll from the system.

Input Parameters

string
required
Unique identifier of the poll to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_A_SURVEYTool to delete a survey by its ID. Use when removing a survey from the system.

Input Parameters

string
required
Unique identifier of the survey to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_AUTOMATIONTool to delete an automation by its ID. Use when removing an automation workflow after confirming the automation ID is correct.

Input Parameters

string
required
The unique identifier of the automation to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_AUTOMATION_EMAILTool 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.

Input Parameters

string
required
The unique identifier of the automation workflow
string
required
The unique identifier of the automation email to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_CONTACT_FROM_ALL_LISTS_BY_IDTool 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.

Input Parameters

string
required
ID of the list where the contact resides
string
required
ID of the contact to delete from all lists

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_CONTACT_FROM_LISTTool 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”

Input Parameters

string
Optional filter value
Optional search filter (e.g., email address)
string
required
List ID
string
required
Contact ID to remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_CONTACT_FROM_SEARCHTool 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.

Input Parameters

string
Optional search filter to apply when deleting the contact
string
required
ID of the contact to delete from the search contact page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_CONTACT_LISTTool to delete a contact list. Use after confirming that the list is no longer in use.

Input Parameters

string
required
ID of the contact list to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_CONTACTS_FROM_ALL_LISTSTool 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.

Input Parameters

string
Filter value to apply when selecting contacts for deletion
string
Search value like email address to filter contacts for deletion

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_CONTACTS_FROM_CURRENT_LISTSDelete contacts from current lists, optionally using search or filter criteria.

Input Parameters

string
Filter value to apply when selecting contacts for deletion
string
Search value like email address to filter contacts for deletion

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_EMAILTool to delete an email campaign. Use when removing a campaign by its ID. Use after confirming the campaign ID is correct.

Input Parameters

string
required
The unique identifier of the email campaign to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_EMAIL_FROM_ARCHIVETool to delete an email from the archive. Use when removing an archived email by its archive ID.

Input Parameters

string
required
Unique identifier of the archive email to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_EMAIL_FROM_TRASHTool to permanently delete an email from trash. Use when permanently removing a trashed email by its ID. This action cannot be undone.

Input Parameters

string
required
ID of the email to permanently delete from trash

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_IMAGETool to delete an image by its ID. Use when removing an image from the Benchmark Email account after confirming the image ID is correct.

Input Parameters

string
required
Unique identifier of the image to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_INBOXTool to delete an inbox by its ID. Use after confirming the inbox ID is correct.

Input Parameters

string
required
Unique identifier of the inbox to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_LINK_ACCOUNTTool to delete a linked agency account. Use when revoking a linked agency account by its ID. Use after confirming the account ID is correct.

Input Parameters

integer
required
ID of the linked agency account to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_LISTTool to delete one or more contact lists by their IDs. Use after confirming that the lists are no longer needed.

Input Parameters

string
required
IDs of the lists to delete (comma-separated for multiple lists)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_PRODUCT_ASSOCIATIONTool to delete a Shopify product association from Benchmark Email. Use when removing a product integration between Shopify and Benchmark Email.

Input Parameters

string
required
Code of the Shopify Product to delete association for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_SEGMENTTool to delete a contact segment by its ID. Use after confirming the segment ID is correct.

Input Parameters

string
required
Unique identifier of the segment to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_SEGMENT_CRITERIATool to delete criteria from a segment. Use after confirming the segment ID exists.

Input Parameters

string
required
ID of the segment whose criteria should be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_TRASH_LISTTool to delete all trash contacts from a list. Use when cleaning up trash contacts from a specific list.

Input Parameters

string
required
ID of the list to delete trash contacts from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_VIDEOTool 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.

Input Parameters

string
required
ID of the video to delete. Can be comma-separated for multiple videos (e.g., ‘video1,video2,video3’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DELETE_WEBHOOKTool to delete a webhook from a contact list by its ID. Use when removing obsolete or invalid webhooks after confirming list and webhook details.

Input Parameters

integer
required
Unique identifier of the webhook to delete
integer
required
ID of the contact list containing the webhook

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_EBAYTool to disconnect the eBay integration from the authenticated account. Use when removing eBay integration or revoking eBay access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_ETSY_INTEGRATIONTool to disconnect Etsy integration from the Benchmark Email account. Use when removing the connection between Benchmark Email and Etsy e-commerce platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_EVENTBRITETool to disconnect the Eventbrite integration from Benchmark Email account. Use when removing Eventbrite integration to stop syncing event attendees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_FACEBOOKDisconnect the Facebook integration from the Benchmark Email account. The response may include a status indicating success or error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_FACEBOOK_EVENTSTool to disconnect the Facebook Events integration from Benchmark Email. Use when removing the Facebook Events connection from the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_INSTAGRAMTool to disconnect the Instagram integration from Benchmark Email account. Use when revoking Instagram access or removing the Instagram connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_LINKED_INTool to disconnect the LinkedIn integration from the Benchmark Email account. Use when removing LinkedIn social media integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_PINTEREST_CONNECTIONTool to disconnect the Pinterest integration from the Benchmark Email account. Use when removing Pinterest connection or revoking Pinterest access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_SALESFORCETool to disconnect the Salesforce integration from Benchmark Email account. Use when revoking the Salesforce CRM connection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_SHOPIFYTool to disconnect Shopify integration from Benchmark Email. Use when removing the connection between Shopify and Benchmark Email accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DISCONNECT_TWITTERTool to disconnect Twitter integration from Benchmark Email account. Use when removing Twitter integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_DOWNLOAD_CONTACT_REPORTRequest a contact list download report for a specific list. The response contains status and a message rather than the exported contact data.

Input Parameters

string
required
ID of the contact list to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GENERATE_TICKETTool to generate a support ticket. Use when you need to create a help desk ticket for customer support or technical assistance.

Input Parameters

string
required
Email address for the ticket correspondence
string
required
Message body of the support ticket describing the issue
string
required
Subject of the support ticket

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_AB_SPLIT_DETAILSTool 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.

Input Parameters

string
required
Unique identifier (ID) of the email campaign to retrieve AB split details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_AB_SPLIT_RESULTSTool to get the results for an AB split test. Use when retrieving performance metrics and outcomes of A/B test campaigns.

Input Parameters

string
required
The unique identifier of the AB split test

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_AB_TEST_REPORTTool to retrieve AB split test reports with pagination. Use when you need to fetch A/B test campaign results.

Input Parameters

string
Column to order by (e.g., Email, count, date)
string
Number of rows per page
string
Page number for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ABUSE_CAMPAIGN_REPORT_BY_EMAIL_IDRetrieve the abuse report count for a specific email campaign by its ID.

Input Parameters

string
required
ID of the email campaign to retrieve the abuse campaign report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ABUSE_REPORTTool to get abuse report containing statistics about email abuse complaints. Use when you need to review abuse complaint metrics and rates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_A_CAMPAIGN_LIST_OF_ENGAGEMENTTool to retrieve campaign engagement statistics. Use when you need to analyze campaign performance metrics including opens, clicks, bounces, and unsubscribes.

Input Parameters

string
Filter text to match campaign names
string
Field name to sort results by
integer
Number of records to return per page
string
Sort direction: ‘asc’ or ‘desc’
integer
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ACCOUNT_SUMMARYTool to get account summary including plan type and image storage limit. Use when checking available image storage space.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ACTIVE_CONTACT_COUNTTool to get the total count of all active contacts/emails in the account. Use when you need to retrieve the active contact count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_A_LIST_OF_AB_TESTSTool to retrieve a list of AB tests with optional filtering and pagination. Use when you need to list or search AB test campaigns.

Input Parameters

string
Filter text to match AB test attributes
string
Field name to sort results by
integer
Number of AB test entries to return per page
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending
string
Type of filter to apply, if supported
integer
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_A_LIST_OF_IMAGESTool to retrieve a list of images. Use when you need to list or search images from the account.

Input Parameters

string
Filter criteria to narrow down the images list
string
Order By Column
string
Number of rows on the page
string
Sequence of order ASC OR DESC
string
Page number to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ALL_CONFIRMED_EMAILSRetrieve the client account’s email confirmation records, including each address and its confirmation status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ARCHIVE_DOMAIN_NAMETool to get the archive domain name for the client. Use when you need to retrieve the configured domain name for email archives.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ARCHIVE_EMAIL_DETAILSTool to get details of an archived email by its ArchiveID. Use when you need to retrieve information about a specific archived email.

Input Parameters

string
required
Unique identifier of the archived email to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ARCHIVE_EMAILSTool to retrieve a list of emails from the archive. Use when you need to list or search archived emails.

Input Parameters

string
Filter for archive name
string
Column by which to sort
string
Number of records to show per page
string
How to sort (asc or desc)
string
Page number to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ARCHIVE_HOME_DATARetrieve archive home data for a specified archive domain and data type.

Input Parameters

string
required
Type of archive data to retrieve. Common values include ‘Home’ for home page data or ‘Image’ for image data.
string
required
Archive domain identifier. This is the encoded domain name for the archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ARCHIVE_HOME_PAGERetrieve archive home page configuration and content, including styling, title, header, footer, and logo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ARCHIVE_PAGESTool to retrieve list of archive pages. Use when you need to view or list all archive pages in the account.

Input Parameters

string
Number of records to show per page
string
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_AUTOMATION_DETAILSTool to get details of an automation by its ID. Use when you need to retrieve information about a specific automation workflow.

Input Parameters

string
required
Unique identifier of the automation to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_AUTOMATION_EMAIL_DETAILSTool to get details for an automation email. Use when retrieving configuration and settings of a specific email in an automation workflow.

Input Parameters

string
required
Automation ID to fetch the email from
string
required
Automation email ID to fetch details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_AUTOMATION_SUMMARY_REPORTTool to get summary report of an automation by ID. Use when you need to retrieve performance metrics and statistics for a specific automation workflow.

Input Parameters

string
required
Unique identifier of the automation to get report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_BADGES_LISTTool to retrieve all available email badges. Use when you need to list or view badge information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_BOUNCES_REPORT_BY_EMAIL_IDTool 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.

Input Parameters

string
Number of records to return per page
string
required
ID of the email campaign to retrieve the bounces report for
string
Page number for pagination (1-based)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CAMPAIGN_HISTORY_BY_EMAIL_IDTool to get campaign history for an email by ID. Use when you need to retrieve historical campaign data for a specific email.

Input Parameters

string
Number of records to return per page
string
required
ID of the email campaign to retrieve the campaign history for
string
Page number for pagination (1-based)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLICK_CONTACT_COUNTTool to get click contact count for email campaigns. Use when you need to retrieve the count of contacts who clicked on emails.

Input Parameters

string
required
Filter type for the query. Use ‘1’ for Any filter
string
required
Comma-separated list of Email IDs to get click contact counts for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLICK_HEATMAP_BY_EMAIL_IDGet the click heatmap count and status for an email campaign by ID.

Input Parameters

string
required
ID of the email campaign to retrieve the click heatmap for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLICK_PERFORMANCE_BY_EMAIL_IDGet the click performance record count and status for an email campaign by ID.

Input Parameters

string
required
ID of the email campaign to retrieve the click performance report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLICK_PERFORMANCE_DETAILS_BY_EMAILTool 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.

Input Parameters

string
required
ID of the email campaign to retrieve click performance details for
integer
Page number for paginated results (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLICKS_REPORT_BY_EMAIL_IDGet the clicks count and status for an email campaign by ID.

Input Parameters

string
required
ID of the email campaign to retrieve the clicks report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLICK_URL_CONTACT_COUNTTool to get click URL contact count of engagement metrics. Use when you need to retrieve engagement statistics for campaign URLs.

Input Parameters

string
Additional click parameter. Specific usage depends on API implementation.
string
List of Campaign Id & URL pairs. Format details may vary based on API requirements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLIENT_ACCOUNT_SETTINGSTool to get client account settings such as company, language, timezone, and sender info. Use when you need to fetch account configuration before sending campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLIENT_DETAILSTool to get client details including profile data, contact count, and plan information. Use when verifying account profile and limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLIENT_FILTER_DOMAINTool to get client filter domains. Use when you need to retrieve the list of whitelisted domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLIENT_PLAN_INFORMATIONTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLIENT_PROFILE_DETAILSTool to get client’s profile details like business city, country, phone, and company. Use after confirming authentication to fetch client profile info.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CLIENTS_RATING_RANGETool to get clients rating range including min, max, and current rating values. Use when you need to retrieve rating information for the authenticated client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_COMMISSION_LISTTool to get the partner commission list. Use when you need to retrieve commission information for partners.

Input Parameters

string
Number of records to show per page
string
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_COMMUNITY_CATEGORYTool to retrieve a list of available community categories. Use when you need to get available category options before adding an email to the community.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_COMMUNITY_DOMAINTool to get the community domain name for the client. Use when you need to retrieve the configured domain for the community.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_COMMUNITY_EMAIL_BY_IDTool to get details of a community email by ID. Use when you need to retrieve information about a specific community email.

Input Parameters

string
required
ID of the community email to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_AUDIT_HISTORYTool to retrieve audit history for contacts in a specific list. Use when you need to track changes and actions performed on contacts.

Input Parameters

string
required
ID of the contact list to retrieve audit history for
integer
Number of records to return per page
integer
Page number for pagination (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_AUDIT_HISTORY_DETAILTool 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.

Input Parameters

string
required
ID of the contact list to retrieve audit history for
string
required
Batch ID from the audit history to get details for
string
required
Group ID within the batch to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_DETAILSTool to retrieve detailed information for a specific contact including custom field values and rating. Use when you need complete contact details from a list.

Input Parameters

string
required
ID of the contact list containing the contact
string
required
ID of the contact to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_IMPORT_STATUSTool to get the status of contact import operations. Use when you need to check the progress or results of a contact import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_LIST_DEEP_VIEWTool to fetch deep view of contact list(s) including all fields and field types. Use when you need comprehensive list metadata and structure information.

Input Parameters

string
required
ID(s) of the contact list(s) to retrieve. For multiple lists, use comma-separated values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_LIST_DETAILSTool to fetch detailed information for a contact list. Use after confirming the list ID to retrieve all metadata.

Input Parameters

string
required
Unique identifier of the contact list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_LIST_FIELD_NAMESRetrieve available field names for a specific contact list.

Input Parameters

string
required
Unique identifier of the contact list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_LISTSRetrieve contact lists with optional pagination, filtering and sorting. Use to list or select a contact list.

Input Parameters

string
Filter text to match list names or attributes
string
Status value to filter lists (e.g., ‘1’ for active)
string ("email" | "date" | "count" | "schedule")
Sort field: ‘email’, ‘date’, ‘count’, or ‘schedule’
integer
Number of lists to return per page
string ("asc" | "desc")
Sort direction: ‘asc’ or ‘desc’
string
Type of filter to apply, if supported
integer
Page number to retrieve (1-based index)
string
Exclude lists that contain this email ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_LISTS_SHOPIFYTool to get Shopify integration contact lists and configuration. Use when retrieving Shopify integration settings or verifying connected contact lists for Shopify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_LIST_SUMMARYGet summary contact counts for a specific list. Total and bounced counts are calculated from response categories, with missing categories treated as zero.

Input Parameters

string
required
ID of the contact list to get summary for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_MERGE_LISTTool 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.

Input Parameters

string
required
ID of the contact list to get merge list information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACT_REPORT_HISTORYTool 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.

Input Parameters

integer
Number of records to return per page
integer
Page number for pagination (1-based index)
string
required
Email address of the contact to retrieve report history for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACTS_COUNTTool 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.

Input Parameters

string
required
Comma-separated IDs of the lists to count contacts from. Use ‘0’ to count from all lists.
string
required
Comma-separated IDs of the segments to count contacts from. Use ‘0’ to count from all segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CONTACTS_IN_LISTTool to fetch filtered and paginated contacts from a list by ListID. Use when narrowing a list via search, filters, and paging.

Input Parameters

string ("2" | "5" | "100")
Subset filter: 2=unsubscribe, 5=hard bounce, 100=others.
string
required
ID of the contact list to query.
string ("email" | "firstname" | "lastname" | "date")
Field to sort by.
integer
Number of contacts per page.
string ("asc" | "desc")
Sort direction.
integer
Pagination page number (starting at 1).
string ("1" | "2" | "3" | "4")
Match type: 1=starts, 2=exact, 3=contains, 4=ends.
string
Field to apply search (e.g., email, firstname).
string
Text filter to search within contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_CURRENT_EMAIL_AT_TIME_OF_RESETTool 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.

Input Parameters

string
Unique ID for the reset request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_DELETE_LIST_CHECKCheck whether specified Benchmark Email contact lists are eligible for deletion before attempting to delete them. The result reports a success or error status, but a success status does not necessarily mean eligibility was explicitly confirmed.

Input Parameters

string
required
Comma-separated list of contact list IDs to check for deletion eligibility

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_DETAILS_ABOUT_ARCHIVE_PAGETool to get details about the archive page including URLs, share settings, and domain. Use when you need to retrieve archive page configuration and URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_DETAILS_OF_POLLTool 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.

Input Parameters

string
required
Unique identifier of the poll to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_DIGIOH_USERNAMETool to get Digioh username for the authenticated account. Use when checking Digioh integration status or retrieving the associated username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_DMARC_LISTTool to retrieve DMARC (Domain-based Message Authentication, Reporting & Conformance) list for the client account. Use when you need to view domain authentication records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_DOWNLOAD_REPORTGet a contact list download report, including list metadata, field definitions and status.

Input Parameters

string
required
ID of the contact list to get download report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_DOWNLOAD_SEGMENT_DATARetrieve download metadata and contact field definitions for a specific segment.

Input Parameters

string
required
Unique identifier of the segment to download data from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EBAY_SELLER_IDTool to get the eBay Seller ID for the authenticated account. Use when retrieving eBay integration details or verifying eBay connection status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EBAY_SITE_LISTTool to retrieve a list of available eBay sites for integration. Use when you need to get eBay site options for connecting eBay accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EDITOR_INTEGRATION_CONNECTION_LISTTool to retrieve the list of editor integration connections. Use when you need to view or list connected integrations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EMAIL_DETAILSTool to get details for a specific email campaign by ID. Use when needing campaign information such as subject, sender, schedule, and contact lists.

Input Parameters

string
required
Unique identifier (ID) of the email campaign to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EMAIL_OPENS_BY_COUNTRY_REGIONTool 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.

Input Parameters

string
required
Two-letter region/state code (e.g., ‘CA’ for California, ‘NY’ for New York)
string
required
Two-letter country code (e.g., ‘US’, ‘GB’, ‘CA’)
string
required
Unique identifier of the email campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EMAIL_PREVIEWTool to get the preview of an email campaign. Use when you need to view the email content before sending.

Input Parameters

string
required
The unique identifier of the email campaign to preview

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EMAIL_RECIPIENT_COUNTTool 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.

Input Parameters

string
required
The unique identifier of the email campaign to get the recipient count for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EMAIL_REPORTTool to get email reports with pagination and filtering options. Use when you need to retrieve a list of email campaign reports.

Input Parameters

string
AB Filter for email reports to filter by A/B test campaigns
integer
Number of records to show per page
string
Type of filter to apply to email reports
integer
Page number for pagination (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EMAIL_REPORT_FORWARDSExport an email campaign’s forwards report to a contact list and return the generated list name and report status.

Input Parameters

string
required
ID of the email campaign to retrieve the forwards report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EMAIL_SPAM_CHECKTool 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.

Input Parameters

string
required
Unique identifier of the email campaign to check for spam

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_ETSY_STORE_NAMETool to get the connected Etsy store name. Use when verifying Etsy integration status or retrieving store details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_EVENTBRITE_USERNAMETool to get the Eventbrite username associated with the Benchmark Email account. Use when verifying Eventbrite integration status or retrieving connected username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_FACEBOOK_ACCOUNT_HOLDERTool to get Facebook account holder information. Use when you need to retrieve details about the connected Facebook account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_FACEBOOK_ACCOUNT_NAMETool to get the Facebook account name from Facebook Events integration. Use when retrieving the connected Facebook account information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_FILTERED_CONTACTS_WITH_EXTRA_FIELDSTool 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.

Input Parameters

string ("2" | "5" | "100")
Subset filter: 2=unsubscribed, 5=hard bounce, 100=others.
string
required
ID of the contact list to query.
string
Field to sort by (e.g., email, firstname, lastname, date).
integer
Number of contacts per page.
string ("asc" | "desc")
Sort direction: asc=ascending, desc=descending.
integer
Pagination page number (starting at 1).
string ("1" | "2" | "3" | "4")
Match type: 1=starts with, 2=exact match, 3=contains, 4=ends with.
string
Field to apply search filter (e.g., email, firstname, lastname).
string
Text filter to search within contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_FORWARDS_REPORT_BY_EMAIL_IDGet the forwards report count and status for an email campaign by ID.

Input Parameters

string
required
ID of the email campaign to retrieve forwards report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_FULL_REPORT_OF_SURVEYTool to retrieve the full report of a survey including all responses and answers. Use when you need to analyze survey results and response data.

Input Parameters

string
required
Unique identifier of the survey to retrieve the full report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_HTML_FOR_ARCHIVE_NEWSLETTERTool 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.

Input Parameters

string
required
The archive domain to retrieve HTML from
string
required
The archive URL to retrieve HTML content for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_HTML_FOR_BUTTONTool 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.

Input Parameters

string
required
ID of the button selected for archive. This identifier determines which button HTML to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_HTML_SIGNUP_FORMTool 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 integration.

Input Parameters

string
required
ID of the signup form to retrieve HTML/JavaScript embed code for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_IMAGE_DETAILSTool to get details of a specific image by its ID. Use when retrieving information about a single image including its URL, size, and dates.

Input Parameters

string
required
Unique identifier of the image to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_IMAGE_FOR_BUTTONTool 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 ‘Image’ button style variant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_INBOX_DETAIL_RESULTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_INBOX_LISTTool to retrieve inbox list with optional filtering and pagination. Use when you need to list or search inbox entries.

Input Parameters

string
Filter text to match inbox attributes
string ("0" | "1")
Filter by completion status: ‘1’ for completed, ‘0’ for not completed
string
Field name to sort results by
integer
Number of inbox entries to return per page
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending
integer
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_INBOX_MASTER_RESULTTool to get Inbox Master Result by ID. Use when retrieving inbox information for a specific inbox identifier.

Input Parameters

string
required
Unique identifier of the inbox to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_INDIVIDUAL_QUESTION_RESULT_DETAIL_INTool 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.

Input Parameters

string
required
Email address of the individual respondent to retrieve results for
string
required
Unique identifier of the survey to retrieve results from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_INTEGRATION_AUTH_URLTool 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.

Input Parameters

string ("SM" | "EB" | "I" | "FB" | "FBE" | "T")
required
Authentication site identifier for the third-party platform to integrate with. SM = Survey Monkey, EB = EventBrite, I = Instagram, FB = Facebook, FBE = Facebook Events, T = Twitter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LAYOUT_LISTTool to retrieve a list of email layouts. Use when you need to list or select a layout for email campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LINK_ACCOUNT_DETAILSTool to get details of a linked agency account. Use when retrieving info for a specific linked account by ID after confirming the account exists.

Input Parameters

integer
required
ID of the linked agency account to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LINKED_IN_TOKENRetrieve LinkedIn integration information for the account, including the associated name and status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_LINK_ACCOUNTSTool to get list of linked agency accounts. Use after linking agency accounts to retrieve all associated accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_MAPPINGTool 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.

Input Parameters

string
required
Unique identifier of the contact list
string
required
Name of the uploaded file to retrieve mapping for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_OF_CONFIRMED_EMAILSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_OF_EMAILSTool to retrieve all email campaigns with optional filters and pagination. Use when you need to list, search, or select an email campaign.

Input Parameters

string
Text filter to search email campaigns by name or subject
string
Filter by status code (e.g., ‘1’ for active campaigns)
string
Field to order results by (e.g., ‘email’, ‘date’, ‘subject’)
string
Filter for A/B split campaigns, if applicable
integer
Number of email campaigns to return per page
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending
string
Type of filter to apply (e.g., search field type)
integer
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_OF_GIPHY_IMAGESTool to retrieve a list of Giphy images. Use when you need to list or search Giphy images available in the account.

Input Parameters

string
Filter criteria to narrow down the Giphy images list
string
Number of records per page
string
Page number to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_OF_HELP_TOPICSTool to retrieve help topics from Benchmark Email. Use when you need to browse or search available help resources.

Input Parameters

string
Number of records to return per page (string format)
string
URL filter to match help topics
string
Page number to retrieve (string format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_OF_POLLSTool to retrieve a list of polls. Use when you need to list or search polls from the account.

Input Parameters

string
Filter criteria to narrow down the polls list
string
Filter by poll status
string
Order by column
string
Number of rows on the page
string
Sequence of order (e.g., ASC or DESC)
string
Page number to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_SHOPIFY_PRODUCTSTool to get a list of Shopify products in HTML format. Use when you need to retrieve Shopify product data for integration purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_LIST_UPLOAD_TERMSRetrieve the account’s list upload terms agreement status and agreement date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_MAGENTO_HTML_DROPTool to get Magento signup form dropdown HTML. Use when integrating Magento with email marketing campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_MAGENTO_HTML_SELECTEDTool 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.

Input Parameters

string
required
ID of the signup form/listbuilder to get Magento HTML for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_NON_CONTACT_COUNTTool 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.

Input Parameters

string
required
Filter type for the query. Use ‘1’ for Any filter type
string
Comma-separated list of Email IDs to check for non-contacts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_NOTIFICATIONTool to get client notifications from Benchmark Email. Use when checking for account alerts or messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_OPEN_CONTACT_COUNTTool 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.

Input Parameters

string
Filter type for the query. Use ‘1’ for Any (default).
string
required
Comma-separated list of email IDs to query for open contact counts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_OPENS_HOURLY_REPORT_BY_EMAILTool 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.

Input Parameters

string
required
ID of the email campaign to retrieve the hourly opens report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_OPENS_LOCATION_REPORTGet an opens location report for an email campaign, with geographic records and open counts.

Input Parameters

string
required
Unique identifier of the email campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_OPENS_LOCATION_REPORT_BY_EMAILTool 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.

Input Parameters

string
required
Unique identifier of the email campaign
string
required
Two-letter country code (e.g., ‘US’, ‘GB’, ‘CA’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_OPENS_REPORTTool 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.

Input Parameters

string
required
ID of the email campaign to retrieve the opens report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_PARTNER_PROFILE_DETAILSTool to get partner profile details including company information and payment settings. Use when you need to fetch partner account configuration and payment preferences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_PAYPAL_LISTSTool to get contact lists formatted for PayPal integration. Returns HTML select dropdown with available contact lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_PINTEREST_USERNAMETool to retrieve the Pinterest username associated with the Benchmark Email account. Use when checking Pinterest integration status or fetching connected Pinterest username.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_POLL_RESPONSE_REPORTTool to retrieve the response report of a poll by ID. Use when you need to analyze poll results and response data.

Input Parameters

string
required
Unique identifier of the poll to retrieve response report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_PREVIEW_OF_A_POLLTool to get a preview/render of a poll by its ID. Use when you need to see how a poll will appear.

Input Parameters

string
required
Unique identifier of the poll to preview

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REFERRALS_LEVEL1_LISTTool to get level 1 referrals list for a specific month and year. Use when you need to retrieve partner referral data.

Input Parameters

string
Sort order for the referrals list. Specify sorting criteria if needed
string
required
Year in 4-digit format (e.g., ‘2024’, ‘2025’, ‘2026’)
string
required
Month in 2-digit format (e.g., ‘01’ for January, ‘12’ for December)
string
Number of records to show per page
string
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REFERRALS_LISTTool to retrieve the list of partner referrals. Use when you need to view referral information for commission tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_ANSWER_COMMENT_IN_SURVEYTool to retrieve comment answers from a survey report for a specific question. Use when analyzing open-ended or comment-type responses from survey participants.

Input Parameters

string
required
Unique identifier of the survey to retrieve comment answers from
string
Optional ID of the specific question to filter comment answers. If not provided, returns all comment answers for the survey.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_ANSWER_OTHER_IN_SURVEYTool 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.

Input Parameters

string
required
Unique identifier of the survey to retrieve ‘other’ answers from
string
Optional ID of the specific question to filter ‘other’ answers. If not provided, returns all ‘other’ answers for the survey.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_ANSWER_TEXT_IN_SURVEYTool to retrieve text answers from survey questions. Use when you need to analyze free-text responses to survey questions.

Input Parameters

string
required
Unique identifier of the survey to retrieve text answers from
string
Optional ID of the specific question to filter text answers. If not provided, returns all text answers for the survey.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_DETAILS_BY_AB_TESTTool 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.

Input Parameters

string
required
Final Unique ID of the email campaign
string
required
ABSplit ID for the AB test

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_DETAILS_BY_EMAIL_IDTool 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.

Input Parameters

string
required
Unique identifier of the email campaign to retrieve report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_DOWNLOADRetrieve report download information for an email campaign and report type, including clicks, forwards, bounces, complaints, or unsubscribes. The response contains report metadata and field information.

Input Parameters

string
required
ID of the email campaign to retrieve the report for
string ("clicks" | "forwards" | "bounces" | "complaints" | "unsubscribes" | "clicks_alt")
required
Type of report to download: clicks (1 or 8), forwards (2), bounces (3), complaints (4), or unsubscribes (5)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_LIST_OF_SURVEYTool to retrieve a paginated list of survey reports. Use when you need to view or analyze survey report data across multiple surveys.

Input Parameters

string
Filter survey reports by survey name
string
Column name to sort by
integer
Number of survey reports to return per page
string ("asc" | "desc")
Sort direction: ‘asc’ for ascending or ‘desc’ for descending
integer
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORT_OF_SURVEY_INDIVIDUAL_RESULTTool to retrieve paginated individual survey results showing who responded and when. Use when you need to list all survey participants and their response metadata.

Input Parameters

string
Filter criteria to apply to the results
string
Field name to sort results by
integer
Number of records to show per page
string
required
Unique identifier of the survey to retrieve individual results for
string
Sort direction: ‘asc’ for ascending or ‘desc’ for descending
integer
Page number for pagination (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_REPORTS_FOR_AUTORESPONDERSTool to get reports for autoresponders with pagination and filtering options. Use when you need to retrieve automation campaign reports or analyze autoresponder performance.

Input Parameters

string
Filter for autoresponders to narrow down report results
integer
Number of records to show per page
integer
Page number for pagination (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_RESEND_CONFIRM_EMAILTool to resend confirmation email to a specific email address. Use when an email address needs to receive a new confirmation link.

Input Parameters

string
required
Email address to resend the confirmation email to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_RSS_HISTORY_BY_EMAIL_IDTool to get RSS history for an email campaign by ID. Use when you need to retrieve RSS feed history for a specific email campaign.

Input Parameters

string
required
ID of the email campaign to retrieve the RSS history for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SALESFORCE_INTEGRATIONTool to get Salesforce integration status and details from Benchmark Email account. Use when checking if Salesforce CRM is connected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SAVE_AS_LISTTool 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.

Input Parameters

string
ID of the AB Test to filter by
string
Type filter for the query
string
ID of the Email to filter by
string
ID of the Event to filter by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SCHEMETool to retrieve color schemes with optional filtering. Use when fetching default or saved color schemes for email templates.

Input Parameters

string
Filter type: ‘default’ for default schemes or ‘saved’ for user-saved schemes
string
Language filter for schemes
string
Filter type parameter for additional filtering

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SEGMENT_AUTO_GENERATE_NAMETool to get an auto-generated segment name for a list. Use when creating segments to get a default name suggestion.

Input Parameters

string
required
ID of the list to generate a segment name for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SEGMENT_BY_IDTool to retrieve details of a specific contact segment by its ID. Use when you need to get information about a particular segment.

Input Parameters

string
required
Unique identifier of the segment to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SEGMENT_DETAILSTool 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.

Input Parameters

string
Field to order results by (e.g., ‘Email’, ‘FirstName’, ‘LastName’, ‘CreatedDate’).
integer
Number of contacts to return per page.
string
required
Unique identifier of the segment to retrieve details for.
string
Sort direction: ‘asc’ for ascending or ‘desc’ for descending.
integer
Page number for pagination (starting at 1). If not specified, returns first page.
string
Match type for search: ‘1’=starts with, ‘2’=exact match, ‘3’=contains, ‘4’=ends with.
string
Field to apply search filter on (e.g., ‘Email’, ‘FirstName’, ‘LastName’).
string
Text filter to search within segment contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SEGMENT_LISTTool 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.

Input Parameters

string
required
ID of the contact list to retrieve segments for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SEGMENTSRetrieve a paginated list of contact segments, with filtering and sorting. A page size, filter value, and sort field are required.

Input Parameters

string
required
Filter value to search segments by name or other attributes. Use empty string for no filtering.
string
required
Field to order results by (e.g., ‘Name’, ‘CreatedDate’, ‘ModifiedDate’, ‘ContactCount’).
integer
required
Number of segments to return per page. Required parameter.
integer
Page number for pagination (starting at 1). If not specified, returns first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SHOPIFY_PRODUCT_LIST_TABULARTool to get Shopify product list in tabular (HTML) format. Use when you need to retrieve product data from a Shopify integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUP_FORM_BUTTON_CODETool 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.

Input Parameters

string
required
Signup Form ID
string
Language for the signup form button code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUP_FORM_CONTACT_FIELDSTool 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.

Input Parameters

string
required
Unique identifier of the signup form to retrieve contact fields for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUP_FORM_DETAILSTool to get details for a specific signup form by ID. Use when needing information about a signup form’s configuration and associated contact lists.

Input Parameters

string
required
Unique identifier of the signup form to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUPFORM_FOR_MAGENTOTool to get SignupForm data for Magento integration. Use when you need to retrieve signup form configuration for integrating with a Magento store.

Input Parameters

string
Listbuilder ID to retrieve specific signup form data for Magento

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUPFORM_FOR_UNBOUNCETool 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.

Input Parameters

string
required
ContactMaster ID - required to get meaningful Unbounce integration results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUP_FORM_LISTTool to retrieve all signup forms (listbuilder forms). Use when you need to list available signup forms for the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUP_FORM_LIST_CONTACTTool 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.

Input Parameters

string
required
ID of the contact list to retrieve associated signup forms

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SIGNUP_FORM_TUMBLERTool to get third-party SignupForm Tumbler query string parameters. Use when you need to retrieve Tumbler integration parameters for a signup form.

Input Parameters

string
Listbuilder ID to filter the Tumbler signup form
string
Email field parameter
string
Title text to filter by
string
Language code to filter by
string
Subscribe button text or parameter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SOCIAL_PERFORMANCE_REPORTTool 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.

Input Parameters

string
required
ID of the email campaign to retrieve the social performance report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SUB_ACCOUNT_BALANCETool 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.

Input Parameters

string
required
Unique identifier (ID) of the sub-account to retrieve balance for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SUB_ACCOUNT_DETAILSTool to get details for a specific sub-account by ID. Use when needing profile and plan info of a child account.

Input Parameters

string
required
Unique identifier (ID) of the sub-account to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SUB_ACCOUNT_HISTORYRetrieve sub-account history entries with billing cycle dates for the client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SUB_ACCOUNT_HISTORY_DETAILSTool to get detailed history information for a specific sub-account billing cycle. Use when you need billing cycle details for a particular history record.

Input Parameters

string
History ID (query parameter, optional)
string
Billing cycle end date
string
required
Unique identifier of the history record to retrieve
string
Billing cycle start date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SUB_ACCOUNTSTool to retrieve all sub-accounts for the client. Use when you need to view or manage sub-accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SUB_ACCOUNTS_PLAN_LISTTool 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.

Input Parameters

string
required
Sub-account holder client ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SURVEY_DETAILSTool to retrieve details of a specific survey by ID. Use when you need information about a survey including its questions and metadata.

Input Parameters

string
required
Unique identifier of the survey to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_SURVEY_REPORT_DETAILTool to get detailed report of a survey including questions, responses, and response counts. Use when needing survey analytics and response data.

Input Parameters

string
required
Unique identifier of the survey to retrieve report details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TEMPLATE_BY_TEMPLATE_IDTool to get details for a specific email template by ID. Use when needing template information such as name, subject, content, and metadata.

Input Parameters

string
required
Unique identifier of the template to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TEMPLATE_CATEGORY_BY_CATEGORY_IDRetrieve the email templates in a specific template category by category ID, optionally filtered by language.

Input Parameters

string
Optional language code for the template category (e.g., ‘en’, ‘es’)
string
required
Unique identifier of the template category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TEMPLATE_CATEGORY_LISTTool to retrieve template category list with optional filters. Use when you need to browse or select email template categories.

Input Parameters

integer
RSS filter: 1 if RSS, 0 otherwise
integer
Version filter for categories
integer
Language filter for template categories

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TEMPLATE_LIST_OF_SURVEYRetrieve the count and status for available survey templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TEMPLATESTool to retrieve email templates from Benchmark Email. Use when you need to list or select an email template for campaigns.

Input Parameters

integer
Number of templates to return per page
integer
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TEMPLATES_FOR_SIGNUP_FORM_CLASSICTool to retrieve templates for Signup Forms (Classic Only). Use when you need to list available signup form templates for the classic editor.

Input Parameters

string
Filter criteria to narrow down the templates list
string
Language code to filter templates (e.g., ‘en’, ‘es’, ‘fr’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_THE_CLEAN_COUNTTool to get the clean count for a contact list. Use when you need to retrieve clean count statistics for a specific list.

Input Parameters

string
Clean type filter parameter
string
Clean type category filter parameter
string
required
ID of the contact list to get clean count for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TRASH_COUNTTool to get the count of contacts in the trash. Use when you need to retrieve the number of deleted contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TUMBLER_LISTSTool to get Tumbler signup form lists in HTML format. Use when you need to retrieve the list of signup forms for Tumbler integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_TWITTER_LOGINTool to get Twitter login/integration status for the authenticated Benchmark Email account. Use when checking if Twitter is connected or retrieving Twitter account details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_UNBOUNCE_LISTSTool to get Unbounce contact lists in HTML format. Use when integrating with Unbounce to retrieve available signup form lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_UNIQUE_COUNTTool to get the total count of unique contacts in the account. Use when needing the unique contact count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_UNOPENS_REPORT_BY_EMAIL_IDTool 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.

Input Parameters

string
required
ID of the email campaign to retrieve the unopens report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_UNSUBSCRIBE_REPORT_BY_EMAIL_IDTool to get unsubscribe report for an email campaign by ID. Use when you need to review recipients who unsubscribed from a specific email campaign.

Input Parameters

string
required
Unique identifier of the email campaign to retrieve unsubscribe report for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_URL_LIST_BY_EMAIL_IDTool to get URL list for a specific email campaign by ID. Use when you need to retrieve all URLs included in an email campaign.

Input Parameters

string
required
ID of the email campaign to retrieve the URL list for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_URL_LIST_OF_ENGAGEMENTTool 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.

Input Parameters

string
Filter text to match URL engagement records
string
Field name to sort results by
string
Comma-separated list of Email IDs to filter engagement data
integer
Number of records to return per page
string
Sort direction: ‘asc’ or ‘desc’
integer
Page number to retrieve (1-based index)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_VIDEO_DETAILSTool to get details for a specific video by its ID. Use when needing information about a video in the Benchmark Email account.

Input Parameters

string
required
ID of the video to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_WEBHOOKSTool to retrieve all webhooks for a contact list. Use when you need to view or list webhooks configured for a specific list.

Input Parameters

string
required
ID of the contact list to retrieve webhooks from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_GET_WEB_PAGE_ADS_DETAILTool to get web page ads detail from the Partner API. Use when you need to retrieve information about web page advertisements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_INITIATE_EMAIL_SCREEN_CAPTURETool 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.

Input Parameters

string
required
ID of the email to capture screen for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_LOG_OUT_TWITTER_TWEETSTool to log out of Twitter Tweets integration from Benchmark Email account. Use when removing Twitter Tweets posting integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_MERGE_CONTACTS_INTO_EXISTING_LISTTool 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.

Input Parameters

string
required
ID of the source contact list(s) to merge contacts from
string
required
ID of the target list to merge contacts into

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_MERGE_CONTACTS_INTO_NEW_LISTTool 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.

Input Parameters

string
required
Name for the new merged contact list
string
required
Comma-separated IDs of the contact lists to merge. Format: ‘12345,67890’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_MOVE_BULK_CONTACTSTool 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.

Input Parameters

string
required
ID of the source list containing contacts to move
string
Optional comma-separated list of contact IDs to move. If not provided, all contacts from the source list will be moved.
string
required
Target List ID(s) as a string. Can be a single list ID or comma-separated list IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_MOVE_CONTACTSTool to move contacts from one list to another. Use when you need to relocate contacts between lists.

Input Parameters

string
required
ID of the source list containing the contacts to move
string
required
Comma-separated list of contact IDs to move
string
required
ID of the target list where contacts will be moved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_MOVE_CONTACT_TO_DO_NOT_CONTACTTool to move a contact to the Do Not Contact (Master Unsubscribe) list. Use when you need to permanently unsubscribe a contact from all communications.

Input Parameters

string
required
ID of the list from which to move the contact
string
required
ID of the contact to move to the Do Not Contact list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_ADD_UPDATE_SCHEMETool to add or update a color scheme. Use when creating new schemes or modifying existing ones with color hex codes.

Input Parameters

string
required
Identifier for the scheme
string
required
Name of the color scheme
array
required
Array of color values (hex codes) for the scheme
string
Language parameter for the scheme
integer
1 to overwrite existing scheme, 0 to not overwrite existing scheme

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_CHANGE_PASSWORDTool to change the password for the client account. Use when updating account credentials after validating new and confirm passwords match.

Input Parameters

string
required
New password for the client account
string
required
Confirmation of the new password; must match NewPassword

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_SAVE_SECURITY_PINTool to save a new security PIN for the client account. Use when you need to update the account PIN after confirming both entries match.

Input Parameters

string
required
New 4-digit security PIN to set for the client account
string
required
Confirmation of the new PIN; must match NewPIN

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_SEND_RESET_EMAILTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_UPDATE_CLIENT_SETTINGSTool to update client account settings. Use after fetching current settings. Updates company info, timezone, language, sender defaults, and signature details.

Input Parameters

object
required
Detail object containing all settings to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_UPDATE_CONTACT_LISTTool to update an existing contact list. Use after confirming list ID and desired modifications to name, description, labels, or custom fields.

Input Parameters

object
required
Payload containing the fields to update
string
required
Identifier of the contact list to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_UPDATE_EDIT_PROFILEUpdate the client profile’s first name, last name, and phone number. All three values are required and sent together.

Input Parameters

string
required
Client’s phone number
string
required
Client’s last name
string
required
Client’s first name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_PATCH_UPDATE_WEBHOOKUpdate a webhook for a contact list by webhook ID. Provide the callback URL, contact list ID, and all event settings for cleaned addresses, email changes, profile updates, subscribes, and unsubscribes.

Input Parameters

integer
required
Unique identifier of the webhook to update
object
required
Settings payload for the webhook
integer
required
ID of the contact list containing the webhook

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_ADD_CONTACT_TO_LISTTool to add a new contact to a specific list. Use after verifying the list ID exists.

Input Parameters

string
required
Contact’s email address
string
required
ID of the contact list to add the new contact to
string
Contact’s last name (optional)
string ("0" | "1")
Email permission flag: ‘1’=grant, ‘0’=decline (optional)
string
Contact’s first name (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_ASSIGN_PRODUCT_LISTTool to assign a Shopify product to a list where purchasers are added. Use when integrating Shopify purchases with email lists.

Input Parameters

string
required
The Benchmark Email list identifier where purchasers will be added
string
required
The Shopify product identifier to assign to the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_CHANGE_SECURITY_PINTool to change security PIN for the client account. Use after confirming your current PIN to rotate your PIN.

Input Parameters

string
required
New 4-digit security PIN to set for the client account
string
required
Current 4-digit security PIN
string
required
Confirmation of the new PIN; must match ResetPIN

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_COPY_POLLTool to copy an existing poll. Use when you need to duplicate a poll with a new name.

Input Parameters

string
required
Name of the copied poll
string
required
ID of the poll to copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_CREATE_CONTACT_LISTTool to create a new contact list. Use after planning list name and optional description.

Input Parameters

string
required
Name of the new contact list
string
Optional description for the contact list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_CREATE_POLLTool to create a new poll in Benchmark Email. Use when you need to create a poll for collecting responses.

Input Parameters

string
required
Name of the poll
string
required
Unique identifier for the poll
string
required
The poll question to be displayed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_CREATE_SEGMENT_CRITERIATool to create criteria for a segment. Use after confirming the segment ID exists and defining filter rules.

Input Parameters

object
required
Criteria configuration containing match type, fetch type, and criteria rules
string
required
ID of the segment to add criteria to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_CREATE_WEBHOOKTool to create a new webhook for a contact list. Use when you need to get callbacks for list events after list creation.

Input Parameters

string
required
ID of the contact list to associate the new webhook with
string
required
The HTTP endpoint URL to receive webhook callbacks
string ("0" | "1")
required
Flag for subscribe event callback: ‘1’ to enable, ‘0’ to disable
string ("0" | "1")
required
Flag for email-changed event callback: ‘1’ to enable, ‘0’ to disable
string ("0" | "1")
required
Flag for unsubscribe event callback: ‘1’ to enable, ‘0’ to disable
string ("0" | "1")
required
Flag for cleaned-address event callback: ‘1’ to enable, ‘0’ to disable
string ("0" | "1")
required
Flag for profile-updates event callback: ‘1’ to enable, ‘0’ to disable
string
required
Same as ListID, the contact list identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_DISABLE_SECURITY_PINTool to disable security PIN for the client account. Use when revoking the current PIN to remove PIN protection.

Input Parameters

string
required
Current 4-digit security PIN to disable

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_LOGIN_REDIRECT_USING_TOKENRequest a token-based login redirect to a specified application path using an existing token. For a non-JSON HTTP 200 response, the tool reports success and returns the requested path as the redirect URL.

Input Parameters

string
required
Redirect path after login (e.g., ‘/Contacts’, ‘/Dashboard’)
string
required
The authentication token value to use for login redirect
string
required
Set to ‘1’ to enable persistent login, ‘0’ to disable

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_SAVE_WEBSITE_DOMAINTool to save a website domain for your Benchmark Email account. Use after account setup to register your domain for link tracking.

Input Parameters

string
required
Domain name to link with your Benchmark Email account (e.g., ‘example.com’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_SEND_CONFIRM_EMAIL_VERIFICATIONTool to send confirm email verification. Use when unverified addresses must receive verification emails after signup.

Input Parameters

string
required
Comma-separated list of email addresses to send verification emails to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_SEND_PIN_EMAILTool to send PIN via email. Use when you forgot your security PIN and need it emailed to you.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_POST_SHOPIFY_PURCHASE_LISTTool to configure Shopify purchase list integration. Use when setting up or updating the contact list for Shopify purchase tracking.

Input Parameters

string
ID of the list to associate with Shopify purchases. If not provided, uses default configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_RESEND_EMAILSTool to resend confirmation emails to contacts in a specific list. Use when you need to resend verification or confirmation emails to contacts.

Input Parameters

string
required
ID of the contact list to resend emails to
string
required
Comma-separated string of contact IDs to resend confirmation emails to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_RESTORE_EMAIL_FROM_TRASHTool to restore an email from trash. Use when you need to recover a deleted email campaign by moving it out of trash.

Input Parameters

string
required
ID of the email to restore from trash

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_RESTORE_TRASH_LISTTool to restore deleted contact lists from trash. Use after confirming the list IDs to recover.

Input Parameters

string
required
IDs of the lists to restore from trash. Can be a single ID or comma-separated IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SAVE_EMAIL_ADDRESSTool 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.

Input Parameters

string
required
ID of the contact list to save email addresses to
string
required
Email address(es) to save. Can be a single email or newline-separated list of emails for multiple addresses

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SAVE_VERIFIED_EMAIL_ADDRESSESTool 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.

Input Parameters

string
required
ID of the contact list to save verified email addresses to
string
required
Newline-separated string of email addresses to mark as verified (e.g., ‘test1@example.com\ntest2@example.com’). Note: The API may reject email addresses with certain domains like example.com.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SCHEDULE_EMAILTool 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.

Input Parameters

string
required
Unique identifier (ID) of the email campaign to schedule
string
required
The date and time to schedule the email for sending. Must be in ISO 8601 datetime format (e.g., ‘2026-02-15T10:00:00’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SEARCH_CONTACT_DETAILS_BY_EMAILTool 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.

Input Parameters

string
required
Email address to search for in the contact database
string
Optional text filter to narrow search results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SEND_SUPPORT_FEEDBACKTool to send support feedback or inquiry to Benchmark Email support team. Use when users need to contact support with questions, issues, or feedback.

Input Parameters

string
required
Full name of the person submitting the support request
string
required
Email address of the person submitting the request for follow-up communication
string
required
Detailed message content describing the issue or question
string
required
Subject line of the support message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SEND_TEST_EMAIL_FOR_SIGNUP_FORMTool to send a test email for a signup form. Use when you need to test the signup form email configuration before going live.

Input Parameters

string
required
Signup form ID to send test email for
string
required
Message body content for the test email
string
required
Subject line for the test email
string
required
Recipient email address for the test email
string
required
From name for the test email
string
required
From email address for the test email

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SET_RESPONSIVETool to set the client’s responsive status. Use when enabling or disabling responsive mode for the client account.

Input Parameters

integer
required
Set responsive status: 1 = Responsive, 0 = Not Responsive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SHARE_LISTS_WITH_SUBACCOUNTSTool to share contact lists with sub-accounts. Use when you need to grant sub-accounts access to a specific list.

Input Parameters

string
required
ID of the contact list to share
string
required
Comma-separated client IDs of sub-accounts to share the list with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SHARE_TEMPLATE_TO_SUB_ACCOUNTSTool to share an email template with sub-accounts. Use when distributing templates across sub-accounts.

Input Parameters

string
required
The unique identifier of the email template to share
array
Array of sub-account IDs to share the template with. Pass an empty array to share with all sub-accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_SHARE_VIDEOTool to share/copy a video to other client accounts. Use when you need to duplicate a video across multiple client accounts.

Input Parameters

string
required
Comma-separated string of client IDs to share the video to. Example: ‘client1,client2’
string
required
ID of the video to share/copy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_EBAY_INTEGRATIONTool to test eBay integration and verify connection status. Use when validating eBay account connectivity and retrieving integration details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_ETSY_INTEGRATIONTool to test the Etsy integration connection with Benchmark Email. Use when verifying if the Etsy integration is properly configured and working.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_EVENTBRITE_INTEGRATIONTool to test the Eventbrite integration connection with Benchmark Email. Use when verifying if Eventbrite is properly connected and syncing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_FACEBOOK_EVENTS_INTEGRATIONTool to test Facebook Events integration in Benchmark Email. Use when verifying the Facebook Events connection is working properly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_FACEBOOK_INTEGRATIONTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_LINKED_IN_CONNECTIONTool to test the LinkedIn integration connection status. Use when verifying if LinkedIn is properly connected to the Benchmark Email account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_PINTEREST_INTEGRATIONTool to test the Pinterest integration connection for the Benchmark Email account. Use when verifying Pinterest integration status or troubleshooting connection issues.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_SALESFORCE_INTEGRATIONTool to test the Salesforce integration connection. Use when verifying that Salesforce CRM is properly connected and accessible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_TWITTER_INTEGRATIONTool to test the Twitter/X integration connection. Use when verifying that Twitter (X) is properly connected and accessible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_TEST_TWITTER_TWEETSTool to test Twitter tweets integration and retrieve follower information. Use to verify Twitter connection and get follower statistics in HTML format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_ARCHIVE_HOME_PAGETool 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.

Input Parameters

string
required
View order for the archive email on the home page
string
required
ID of the email which want to add as archive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_ARCHIVE_HOME_PAGE_DATATool 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.

Input Parameters

object
required
Archive home page data containing page title, logo, header, and footer information

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_CONTACT_DETAILSTool to update contact details in a specific list. Use when you need to modify a contact’s email, name, or rating.

Input Parameters

object
required
Contact data to update
string
required
ID of the contact list
string
required
ID of the contact to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_EMAILTool to update an existing email campaign. Use to modify campaign properties such as name, subject, sender name, sender email, or reply-to address.

Input Parameters

string
required
Unique identifier of the email campaign to update
object
required
Payload containing the fields to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_EMAIL_CONTENT_FOR_AUTOMATIONTool to update email content for an automation workflow. Use when modifying the subject, template content, or sender details of an existing automation email.

Input Parameters

object
required
Email content object containing the fields to update
string
required
ID of the automation workflow containing the email
string
required
ID of the automation email to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_LINK_ACCOUNTUpdate a linked agency account by ID, supplying its login, password, and alias together.

Input Parameters

string
required
Link Account ID to update
string
required
Alias name for the link account
string
required
Login email/ID for the link account
string
required
Password for the link account (must be valid Benchmark Email account password)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_LIST_COMPILATION_DETAILSUpdate compilation details for a contact list file upload using the list ID, uploaded file names and compilation mode.

Input Parameters

string
required
Compilation mode setting (typically ‘0’ for standard mode)
string
required
ID of the contact list whose compilation details should be changed
string
required
Name of the compiled file on the server (e.g., ‘fehokpdx.x0o.csv’)
string
required
Original name of the uploaded file (e.g., ‘test_contacts.csv’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_PARTNER_PROFILETool 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.

Input Parameters

object
required
Partner profile details to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_POLLUpdate an existing Benchmark Email poll’s name and question by poll ID. Both the name and question must be supplied.

Input Parameters

string
required
Updated name of the poll
string
required
Unique identifier of the poll to update
string
required
Updated poll question to be displayed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_RESET_EMAILTool 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.

Input Parameters

string
required
The ID which is available on the email link sent for resetting the email
string
required
The new email address to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_SEGMENTTool to update an existing contact segment. Use when you need to modify a segment’s name, description, or associated list ID.

Input Parameters

object
required
Payload containing the fields to update
string
required
Unique identifier of the segment to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPDATE_SURVEY_STATUSTool to update the status of a survey. Use when activating, deactivating, or removing a survey.

Input Parameters

string ("inactive" | "active" | "removed")
required
New status for the survey: active (1), inactive (0), or removed (3)
string
required
Unique identifier of the survey to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BENCHMARK_EMAIL_UPLOAD_VIDEOTool to upload a video via URL. Use when adding videos from external sources (YouTube, Vimeo, etc.) to the Benchmark Email account.

Input Parameters

string
required
URL of the video to upload (e.g., YouTube, Vimeo URL)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not