# Benchmark Email

Benchmark Email is a comprehensive email marketing platform offering tools for creating, sending, and analyzing email campaigns.

- **Category:** email newsletters
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 300
- **Triggers:** 0
- **Slug:** `BENCHMARK_EMAIL`
- **Version:** 20260227_00

## Tools

### Add Email in Automation

**Slug:** `BENCHMARK_EMAIL_ADD_EMAIL_IN_AUTOMATION`

Tool to add an email to an automation workflow. Use when configuring automation sequences for email campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Days` | string | No | Number of days for scheduling the automation email |
| `ListID` | string | No | Contact list ID associated with the automation |
| `EmailID` | string | No | Email template ID to use for the automation |
| `Subject` | string | No | Email subject line |
| `PreviewText` | string | No | Preview text displayed before opening the email |
| `TriggerLink` | string | No | Link that triggers the automation |
| `TriggerType` | string | No | Type of trigger for the automation email |
| `AutomationID` | string | Yes | ID of the automation workflow to add the email to |
| `TriggerField` | string | No | Field that triggers the automation |
| `TriggerEmailID` | string | No | ID of the email that triggers this automation |
| `GoogleCampaignName` | string | No | Google Analytics campaign name for tracking |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Email to Archive

**Slug:** `BENCHMARK_EMAIL_ADD_EMAIL_TO_ARCHIVE`

Tool to add an email to the archive page. Use when you need to archive an email campaign by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `EmailID` | string | Yes | ID of the email to add to archive |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Email to Community

**Slug:** `BENCHMARK_EMAIL_ADD_EMAIL_TO_COMMUNITY`

Tool to add an email campaign to the public community with category and keywords. Use after creating an email campaign to publish it to the community platform.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | ID of the email campaign to add to community |
| `Keywords` | string | No | Comma-separated keyword tags for categorization |
| `Community` | string | Yes | Category for the email in the public community |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add/Remove Inbox Tests from Sub-Account

**Slug:** `BENCHMARK_EMAIL_ADD_REMOVE_INBOX_TESTS_FROM_SUB_ACCOUNT`

Tool to add or remove inbox tests from a sub-account. Use when you need to allocate or deallocate inbox testing credits for a child account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Sub-Account holder Client ID |
| `Tests` | integer | Yes | Number of inbox tests to add/remove. Positive values add tests, negative values remove tests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check if responsive

**Slug:** `BENCHMARK_EMAIL_CHECK_IF_RESPONSIVE`

Tool to check if the client is responsive. Use when verifying client responsiveness status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clean Contact List

**Slug:** `BENCHMARK_EMAIL_CLEAN_CONTACT_LIST`

Tool to clean a contact list by removing invalid or bounced email addresses. Use when you need to improve list quality.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list to be cleaned |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Compare Contacts

**Slug:** `BENCHMARK_EMAIL_COMPARE_CONTACTS`

Tool to compare contacts across multiple contact lists. Use when you need to identify shared or unique contacts between lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | Comma-separated list IDs to compare (e.g., '1,2' or '15242968,15242969') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Connect Third-Party Service

**Slug:** `BENCHMARK_EMAIL_CONNECT_SERVICE`

Tool to get the OAuth authorization URL for connecting a third-party e-commerce or CRM service. Use when integrating with ETSY, EBAY, SHOPIFY, or SALESFORCE.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `AuthSite` | string ("ETSY" | "EBAY" | "SHOPIFY" | "SALESFORCE") | Yes | The third-party authentication site to connect to (ETSY, EBAY, SHOPIFY, or SALESFORCE) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Bulk Contacts

**Slug:** `BENCHMARK_EMAIL_COPY_BULK_CONTACTS`

Tool to copy multiple contacts in bulk to target lists. Use when you need to duplicate contacts across lists without moving them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ContactIDs` | string | Yes | Comma separated list of Contact IDs to copy |
| `TargetListIDs` | string | Yes | Target List ID where contacts will be copied to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Contacts

**Slug:** `BENCHMARK_EMAIL_COPY_CONTACTS`

Tool to copy a contact to a specific list. Use when you need to duplicate a contact from one list to another.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list to copy the contact to |
| `contact_id` | string | Yes | ID of the contact to copy |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Email in Automation

**Slug:** `BENCHMARK_EMAIL_COPY_EMAIL_IN_AUTOMATION`

Tool to create a copy of an automation email. Use when duplicating an email within an automation workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `automation_id` | string | Yes | Automation ID where the email exists |
| `automation_detail_id` | string | Yes | Automation email ID to copy |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Existing Email

**Slug:** `BENCHMARK_EMAIL_COPY_EXISTING_EMAIL`

Tool to copy an existing email. Use when duplicating an email campaign by its ID. The copied email will have a new ID and the specified name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | ID of the email to copy |
| `Name` | string | Yes | Name for the copied email |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Image to Sub-Account

**Slug:** `BENCHMARK_EMAIL_COPY_IMAGE_TO_SUB_ACCOUNT`

Tool to copy an image to one or more sub-accounts. Use when sharing an image with specific sub-accounts by providing comma-separated client IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Clients` | string | Yes | 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. |
| `ImageID` | string | Yes | Unique identifier of the image to copy |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Signup Form

**Slug:** `BENCHMARK_EMAIL_COPY_SIGNUP_FORM`

Tool to copy an existing signup form. Use when you need to duplicate a signup form with a new name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | ID of the signup form to copy |
| `Name` | string | Yes | Name of the copied signup form |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Automation Copy

**Slug:** `BENCHMARK_EMAIL_CREATE_AUTOMATION_COPY`

Tool to create a copy of an existing automation. Use after confirming the automation ID to duplicate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | Name for the copied automation |
| `AutomationID` | string | Yes | ID of the automation to copy |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Inbox

**Slug:** `BENCHMARK_EMAIL_CREATE_INBOX`

Tool to create a new inbox for email testing. Use when you need to set up an inbox for testing email campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `TestID` | string | Yes | Test ID (ID of the application in which the test is required) |
| `EmailID` | string | Yes | Email ID for the inbox |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segment from Contact IDs

**Slug:** `BENCHMARK_EMAIL_CREATE_SEGMENT_FROM_CONTACT_IDS`

Tool to create a segment from a list of contact IDs. Use after collecting contact IDs to group them into a segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | ID of the contact list where the segment will be created |
| `ContactIDs` | array | Yes | Array of contact IDs to include in the segment. Must contain at least one contact ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Signup Form

**Slug:** `BENCHMARK_EMAIL_CREATE_SIGNUP_FORM`

Tool to create a new signup form for collecting email subscribers. Use when you need to set up a subscription form with associated contact lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | Name of the signup form |
| `Lists` | array | Yes | List of contact lists to associate with the signup form. Each list requires ID and Name fields. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete ABSplit Campaign

**Slug:** `BENCHMARK_EMAIL_DELETE_ABSPLIT_CAMPAIGN`

Tool to delete an ABSplit campaign configuration from an email. Use when removing A/B split test settings from a campaign by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the email campaign whose ABSplit to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete AB Test Email

**Slug:** `BENCHMARK_EMAIL_DELETE_AB_TEST_EMAIL`

Tool to move an AB test email to trash. Use when removing an AB split test by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the AB split test email to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete A Poll

**Slug:** `BENCHMARK_EMAIL_DELETE_A_POLL`

Tool to delete a poll by its ID. Use when removing a poll from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poll_id` | string | Yes | Unique identifier of the poll to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete A Survey

**Slug:** `BENCHMARK_EMAIL_DELETE_A_SURVEY`

Tool to delete a survey by its ID. Use when removing a survey from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `survey_id` | string | Yes | Unique identifier of the survey to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Automation

**Slug:** `BENCHMARK_EMAIL_DELETE_AUTOMATION`

Tool to delete an automation by its ID. Use when removing an automation workflow after confirming the automation ID is correct.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `automation_id` | string | Yes | The unique identifier of the automation to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Automation Email

**Slug:** `BENCHMARK_EMAIL_DELETE_AUTOMATION_EMAIL`

Tool to delete an automation email from an automation workflow. Use when removing a specific email from an automation sequence by providing both the automation ID and automation email ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `automation_id` | string | Yes | The unique identifier of the automation workflow |
| `automation_detail_id` | string | Yes | The unique identifier of the automation email to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact From All Lists By ID

**Slug:** `BENCHMARK_EMAIL_DELETE_CONTACT_FROM_ALL_LISTS_BY_ID`

Tool to delete a specific contact from all lists by list ID and contact ID. Use when you need to remove a contact globally from all lists using the contact details page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list where the contact resides |
| `contact_id` | string | Yes | ID of the contact to delete from all lists |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact From List

**Slug:** `BENCHMARK_EMAIL_DELETE_CONTACT_FROM_LIST`

Tool to delete a contact from a specific list by ContactID. Use when you have list and contact IDs. Example: "Delete contact 2040826674 from list 15257899"

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Optional filter value |
| `search` | string | No | Optional search filter (e.g., email address) |
| `list_id` | string | Yes | List ID |
| `contact_id` | string | Yes | Contact ID to remove |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact From Search

**Slug:** `BENCHMARK_EMAIL_DELETE_CONTACT_FROM_SEARCH`

Tool to delete a contact from the search contact page. Use when you need to remove a contact by its ContactID directly from the search results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Optional search filter to apply when deleting the contact |
| `contact_id` | string | Yes | ID of the contact to delete from the search contact page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact List

**Slug:** `BENCHMARK_EMAIL_DELETE_CONTACT_LIST`

Tool to delete a contact list. Use after confirming that the list is no longer in use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contacts From All Lists

**Slug:** `BENCHMARK_EMAIL_DELETE_CONTACTS_FROM_ALL_LISTS`

Tool to delete selected contacts from all lists. Use when you need to remove contacts globally across all lists, optionally filtered by search or filter criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter value to apply when selecting contacts for deletion |
| `search` | string | No | Search value like email address to filter contacts for deletion |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contacts From Current Lists

**Slug:** `BENCHMARK_EMAIL_DELETE_CONTACTS_FROM_CURRENT_LISTS`

Tool to delete selected contacts from current lists. Use when you need to remove contacts from current lists, filtered by search or filter criteria.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter value to apply when selecting contacts for deletion |
| `search` | string | No | Search value like email address to filter contacts for deletion |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Campaign

**Slug:** `BENCHMARK_EMAIL_DELETE_EMAIL`

Tool to delete an email campaign. Use when removing a campaign by its ID. Use after confirming the campaign ID is correct.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the email campaign to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email from Archive

**Slug:** `BENCHMARK_EMAIL_DELETE_EMAIL_FROM_ARCHIVE`

Tool to delete an email from the archive. Use when removing an archived email by its archive ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Unique identifier of the archive email to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanently Delete Email from Trash

**Slug:** `BENCHMARK_EMAIL_DELETE_EMAIL_FROM_TRASH`

Tool to permanently delete an email from trash. Use when permanently removing a trashed email by its ID. This action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | ID of the email to permanently delete from trash |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Image

**Slug:** `BENCHMARK_EMAIL_DELETE_IMAGE`

Tool to delete an image by its ID. Use when removing an image from the Benchmark Email account after confirming the image ID is correct.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ImageID` | string | Yes | Unique identifier of the image to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inbox

**Slug:** `BENCHMARK_EMAIL_DELETE_INBOX`

Tool to delete an inbox by its ID. Use after confirming the inbox ID is correct.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | Unique identifier of the inbox to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Linked Agency Account

**Slug:** `BENCHMARK_EMAIL_DELETE_LINK_ACCOUNT`

Tool to delete a linked agency account. Use when revoking a linked agency account by its ID. Use after confirming the account ID is correct.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | integer | Yes | ID of the linked agency account to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List

**Slug:** `BENCHMARK_EMAIL_DELETE_LIST`

Tool to delete one or more contact lists by their IDs. Use after confirming that the lists are no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | IDs of the lists to delete (comma-separated for multiple lists) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product Association

**Slug:** `BENCHMARK_EMAIL_DELETE_PRODUCT_ASSOCIATION`

Tool to delete a Shopify product association from Benchmark Email. Use when removing a product integration between Shopify and Benchmark Email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ProductCode` | string | Yes | Code of the Shopify Product to delete association for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Segment

**Slug:** `BENCHMARK_EMAIL_DELETE_SEGMENT`

Tool to delete a contact segment by its ID. Use after confirming the segment ID is correct.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Unique identifier of the segment to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Segment Criteria

**Slug:** `BENCHMARK_EMAIL_DELETE_SEGMENT_CRITERIA`

Tool to delete criteria from a segment. Use after confirming the segment ID exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | ID of the segment whose criteria should be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Trash List

**Slug:** `BENCHMARK_EMAIL_DELETE_TRASH_LIST`

Tool to delete all trash contacts from a list. Use when cleaning up trash contacts from a specific list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list to delete trash contacts from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Video

**Slug:** `BENCHMARK_EMAIL_DELETE_VIDEO`

Tool to delete one or more videos by their IDs. Use when removing videos from the Benchmark Email account after confirming the video IDs are correct.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `VideoID` | string | Yes | ID of the video to delete. Can be comma-separated for multiple videos (e.g., 'video1,video2,video3'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `BENCHMARK_EMAIL_DELETE_WEBHOOK`

Tool to delete a webhook from a contact list by its ID. Use when removing obsolete or invalid webhooks after confirming list and webhook details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | integer | Yes | Unique identifier of the webhook to delete |
| `ListID` | integer | Yes | ID of the contact list containing the webhook |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect eBay Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_EBAY`

Tool to disconnect the eBay integration from the authenticated account. Use when removing eBay integration or revoking eBay access.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Etsy Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_ETSY_INTEGRATION`

Tool to disconnect Etsy integration from the Benchmark Email account. Use when removing the connection between Benchmark Email and Etsy e-commerce platform.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Eventbrite Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_EVENTBRITE`

Tool to disconnect the Eventbrite integration from Benchmark Email account. Use when removing Eventbrite integration to stop syncing event attendees.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Facebook Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_FACEBOOK`

Tool to disconnect Facebook integration from Benchmark Email account. Use when revoking Facebook integration. Returns status 1 on success, -1 on error.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Facebook Events

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_FACEBOOK_EVENTS`

Tool to disconnect the Facebook Events integration from Benchmark Email. Use when removing the Facebook Events connection from the account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Instagram Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_INSTAGRAM`

Tool to disconnect the Instagram integration from Benchmark Email account. Use when revoking Instagram access or removing the Instagram connection.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect LinkedIn Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_LINKED_IN`

Tool to disconnect the LinkedIn integration from the Benchmark Email account. Use when removing LinkedIn social media integration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Pinterest Connection

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_PINTEREST_CONNECTION`

Tool to disconnect the Pinterest integration from the Benchmark Email account. Use when removing Pinterest connection or revoking Pinterest access.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Salesforce Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_SALESFORCE`

Tool to disconnect the Salesforce integration from Benchmark Email account. Use when revoking the Salesforce CRM connection.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Shopify

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_SHOPIFY`

Tool to disconnect Shopify integration from Benchmark Email. Use when removing the connection between Shopify and Benchmark Email accounts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disconnect Twitter Integration

**Slug:** `BENCHMARK_EMAIL_DISCONNECT_TWITTER`

Tool to disconnect Twitter integration from Benchmark Email account. Use when removing Twitter integration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Contact Report

**Slug:** `BENCHMARK_EMAIL_DOWNLOAD_CONTACT_REPORT`

Tool to download contact list report. Use when you need to export or download contact data for a specific list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the contact list to download |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Support Ticket

**Slug:** `BENCHMARK_EMAIL_GENERATE_TICKET`

Tool to generate a support ticket. Use when you need to create a help desk ticket for customer support or technical assistance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Email` | string | Yes | Email address for the ticket correspondence |
| `Message` | string | Yes | Message body of the support ticket describing the issue |
| `Subject` | string | Yes | Subject of the support ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AB Split Details

**Slug:** `BENCHMARK_EMAIL_GET_AB_SPLIT_DETAILS`

Tool to get details for an AB split test by email ID. Use when you need to retrieve A/B test configuration and status for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (ID) of the email campaign to retrieve AB split details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AB Split Results

**Slug:** `BENCHMARK_EMAIL_GET_AB_SPLIT_RESULTS`

Tool to get the results for an AB split test. Use when retrieving performance metrics and outcomes of A/B test campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the AB split test |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AB Test Report

**Slug:** `BENCHMARK_EMAIL_GET_AB_TEST_REPORT`

Tool to retrieve AB split test reports with pagination. Use when you need to fetch A/B test campaign results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `OrderBy` | string | No | Column to order by (e.g., Email, count, date) |
| `PageSize` | string | No | Number of rows per page |
| `PageNumber` | string | No | Page number for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Abuse Campaign Report By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_ABUSE_CAMPAIGN_REPORT_BY_EMAIL_ID`

Tool to get abuse campaign report for an email by ID. Use when you need to retrieve abuse report data for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the abuse campaign report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Abuse Report

**Slug:** `BENCHMARK_EMAIL_GET_ABUSE_REPORT`

Tool to get abuse report containing statistics about email abuse complaints. Use when you need to review abuse complaint metrics and rates.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Engagement List

**Slug:** `BENCHMARK_EMAIL_GET_A_CAMPAIGN_LIST_OF_ENGAGEMENT`

Tool to retrieve campaign engagement statistics. Use when you need to analyze campaign performance metrics including opens, clicks, bounces, and unsubscribes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter text to match campaign names |
| `order_by` | string | No | Field name to sort results by |
| `page_size` | integer | No | Number of records to return per page |
| `sort_order` | string | No | Sort direction: 'asc' or 'desc' |
| `page_number` | integer | No | Page number to retrieve (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get account summary

**Slug:** `BENCHMARK_EMAIL_GET_ACCOUNT_SUMMARY`

Tool to get account summary including plan type and image storage limit. Use when checking available image storage space.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Active Contact Count

**Slug:** `BENCHMARK_EMAIL_GET_ACTIVE_CONTACT_COUNT`

Tool to get the total count of all active contacts/emails in the account. Use when you need to retrieve the active contact count.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a List of AB Tests

**Slug:** `BENCHMARK_EMAIL_GET_A_LIST_OF_AB_TESTS`

Tool to retrieve a list of AB tests with optional filtering and pagination. Use when you need to list or search AB test campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter text to match AB test attributes |
| `order_by` | string | No | Field name to sort results by |
| `page_size` | integer | No | Number of AB test entries to return per page |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: 'asc' for ascending or 'desc' for descending |
| `filter_type` | string | No | Type of filter to apply, if supported |
| `page_number` | integer | No | Page number to retrieve (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of images

**Slug:** `BENCHMARK_EMAIL_GET_A_LIST_OF_IMAGES`

Tool to retrieve a list of images. Use when you need to list or search images from the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter criteria to narrow down the images list |
| `order_by` | string | No | Order By Column |
| `page_size` | string | No | Number of rows on the page |
| `sort_order` | string | No | Sequence of order ASC OR DESC |
| `page_number` | string | No | Page number to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Confirmed Emails

**Slug:** `BENCHMARK_EMAIL_GET_ALL_CONFIRMED_EMAILS`

Tool to retrieve all confirmed email addresses for the client account. Use after user completes email confirmation flows to fetch final list.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Archive Domain Name

**Slug:** `BENCHMARK_EMAIL_GET_ARCHIVE_DOMAIN_NAME`

Tool to get the archive domain name for the client. Use when you need to retrieve the configured domain name for email archives.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Archive Email Details

**Slug:** `BENCHMARK_EMAIL_GET_ARCHIVE_EMAIL_DETAILS`

Tool to get details of an archived email by its ArchiveID. Use when you need to retrieve information about a specific archived email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `archive_id` | string | Yes | Unique identifier of the archived email to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Archive Emails

**Slug:** `BENCHMARK_EMAIL_GET_ARCHIVE_EMAILS`

Tool to retrieve a list of emails from the archive. Use when you need to list or search archived emails.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter for archive name |
| `order_by` | string | No | Column by which to sort |
| `page_size` | string | No | Number of records to show per page |
| `sort_order` | string | No | How to sort (asc or desc) |
| `page_number` | string | No | Page number to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Archive Home Data

**Slug:** `BENCHMARK_EMAIL_GET_ARCHIVE_HOME_DATA`

Tool to get archive home data for a specific domain and type. Use when retrieving details of an archived email by its domain identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | Type of archive data to retrieve. Common values include 'Home' for home page data or 'Image' for image data. |
| `domain` | string | Yes | Archive domain identifier. This is the encoded domain name for the archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Archive Home Page

**Slug:** `BENCHMARK_EMAIL_GET_ARCHIVE_HOME_PAGE`

Tool to get the archive home page containing archive entries. Use when retrieving archive listing or home page data.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Archive Pages

**Slug:** `BENCHMARK_EMAIL_GET_ARCHIVE_PAGES`

Tool to retrieve list of archive pages. Use when you need to view or list all archive pages in the account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get automation details

**Slug:** `BENCHMARK_EMAIL_GET_AUTOMATION_DETAILS`

Tool to get details of an automation by its ID. Use when you need to retrieve information about a specific automation workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `automation_id` | string | Yes | Unique identifier of the automation to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Email Details

**Slug:** `BENCHMARK_EMAIL_GET_AUTOMATION_EMAIL_DETAILS`

Tool to get details for an automation email. Use when retrieving configuration and settings of a specific email in an automation workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `automation_id` | string | Yes | Automation ID to fetch the email from |
| `automation_detail_id` | string | Yes | Automation email ID to fetch details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get automation summary report

**Slug:** `BENCHMARK_EMAIL_GET_AUTOMATION_SUMMARY_REPORT`

Tool to get summary report of an automation by ID. Use when you need to retrieve performance metrics and statistics for a specific automation workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `automation_id` | string | Yes | Unique identifier of the automation to get report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Badges List

**Slug:** `BENCHMARK_EMAIL_GET_BADGES_LIST`

Tool to retrieve all available email badges. Use when you need to list or view badge information.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bounces Report By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_BOUNCES_REPORT_BY_EMAIL_ID`

Tool to get bounces report for an email campaign by ID. Use when you need to retrieve information about bounced emails for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the bounces report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign History By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_CAMPAIGN_HISTORY_BY_EMAIL_ID`

Tool to get campaign history for an email by ID. Use when you need to retrieve historical campaign data for a specific email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the campaign history for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Click Contact Count

**Slug:** `BENCHMARK_EMAIL_GET_CLICK_CONTACT_COUNT`

Tool to get click contact count for email campaigns. Use when you need to retrieve the count of contacts who clicked on emails.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter_type` | string | Yes | Filter type for the query. Use '1' for Any filter |
| `email_id_list` | string | Yes | Comma-separated list of Email IDs to get click contact counts for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Click HeatMap By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_CLICK_HEATMAP_BY_EMAIL_ID`

Tool to get click heatmap report for an email by ID. Use when you need to analyze the click patterns and visualize which links in an email campaign received the most engagement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the click heatmap for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Click Performance By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_CLICK_PERFORMANCE_BY_EMAIL_ID`

Tool to get click performance report for an email by ID. Use when you need to retrieve click performance metrics for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the click performance report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Click Performance Details By Email

**Slug:** `BENCHMARK_EMAIL_GET_CLICK_PERFORMANCE_DETAILS_BY_EMAIL`

Tool to get click performance details for an email campaign by ID. Use when you need detailed click tracking data including who clicked, when, and which links were clicked.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve click performance details for |
| `page_number` | integer | No | Page number for paginated results (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Clicks Report By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_CLICKS_REPORT_BY_EMAIL_ID`

Tool to get clicks report for an email by ID. Use when you need to retrieve the list of contacts who clicked links in a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the clicks report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Click URL Contact Count

**Slug:** `BENCHMARK_EMAIL_GET_CLICK_URL_CONTACT_COUNT`

Tool to get click URL contact count of engagement metrics. Use when you need to retrieve engagement statistics for campaign URLs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `click_all` | string | No | Additional click parameter. Specific usage depends on API implementation. |
| `campaign_url_list` | string | No | List of Campaign Id & URL pairs. Format details may vary based on API requirements. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Client Account Settings

**Slug:** `BENCHMARK_EMAIL_GET_CLIENT_ACCOUNT_SETTINGS`

Tool to get client account settings such as company, language, timezone, and sender info. Use when you need to fetch account configuration before sending campaigns.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get client details

**Slug:** `BENCHMARK_EMAIL_GET_CLIENT_DETAILS`

Tool to get client details including profile data, contact count, and plan information. Use when verifying account profile and limits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get client filter domain

**Slug:** `BENCHMARK_EMAIL_GET_CLIENT_FILTER_DOMAIN`

Tool to get client filter domains. Use when you need to retrieve the list of whitelisted domains.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Client Plan Information

**Slug:** `BENCHMARK_EMAIL_GET_CLIENT_PLAN_INFORMATION`

Tool to get client's plan information including addons, email plan, and total contacts. Use when you need the current plan details before managing upgrades or billing.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get client profile details

**Slug:** `BENCHMARK_EMAIL_GET_CLIENT_PROFILE_DETAILS`

Tool to get client's profile details like business city, country, phone, and company. Use after confirming authentication to fetch client profile info.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get clients rating range

**Slug:** `BENCHMARK_EMAIL_GET_CLIENTS_RATING_RANGE`

Tool to get clients rating range including min, max, and current rating values. Use when you need to retrieve rating information for the authenticated client.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Commission List

**Slug:** `BENCHMARK_EMAIL_GET_COMMISSION_LIST`

Tool to get the partner commission list. Use when you need to retrieve commission information for partners.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Community Category

**Slug:** `BENCHMARK_EMAIL_GET_COMMUNITY_CATEGORY`

Tool to retrieve a list of available community categories. Use when you need to get available category options before adding an email to the community.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get community domain

**Slug:** `BENCHMARK_EMAIL_GET_COMMUNITY_DOMAIN`

Tool to get the community domain name for the client. Use when you need to retrieve the configured domain for the community.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Community Email By ID

**Slug:** `BENCHMARK_EMAIL_GET_COMMUNITY_EMAIL_BY_ID`

Tool to get details of a community email by ID. Use when you need to retrieve information about a specific community email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the community email to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Audit History

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_AUDIT_HISTORY`

Tool to retrieve audit history for contacts in a specific list. Use when you need to track changes and actions performed on contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list to retrieve audit history for |
| `page_size` | integer | No | Number of records to return per page |
| `page_number` | integer | No | Page number for pagination (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Audit History Detail

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_AUDIT_HISTORY_DETAIL`

Tool to get detailed audit history for a specific batch and group of contact changes. Use after getting BatchID and GroupID from the audit history endpoint to retrieve detailed information about contact modifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list to retrieve audit history for |
| `batch_id` | string | Yes | Batch ID from the audit history to get details for |
| `group_id` | string | Yes | Group ID within the batch to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Details

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_DETAILS`

Tool to retrieve detailed information for a specific contact including custom field values and rating. Use when you need complete contact details from a list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list containing the contact |
| `contact_id` | string | Yes | ID of the contact to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Import Status

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_IMPORT_STATUS`

Tool to get the status of contact import operations. Use when you need to check the progress or results of a contact import.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact List Deep View

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_LIST_DEEP_VIEW`

Tool to fetch deep view of contact list(s) including all fields and field types. Use when you need comprehensive list metadata and structure information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | ID(s) of the contact list(s) to retrieve. For multiple lists, use comma-separated values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact List Details

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_LIST_DETAILS`

Tool to fetch detailed information for a contact list. Use after confirming the list ID to retrieve all metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | Unique identifier of the contact list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact List Field Names

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_LIST_FIELD_NAMES`

Tool to retrieve field names and attributes for a contact list. Use when you need to get available fields for a specific list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | Unique identifier of the contact list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Lists

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_LISTS`

Tool to retrieve all contact lists. Use when you need to list or select a contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter text to match list names or attributes |
| `status` | string | No | Status value to filter lists (e.g., '1' for active) |
| `order_by` | string ("email" | "date" | "count" | "schedule") | No | Sort field: 'email', 'date', 'count', or 'schedule' |
| `page_size` | integer | No | Number of lists to return per page |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: 'asc' or 'desc' |
| `filter_type` | string | No | Type of filter to apply, if supported |
| `page_number` | integer | No | Page number to retrieve (1-based index) |
| `exclude_email_id` | string | No | Exclude lists that contain this email ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Lists for Shopify

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_LISTS_SHOPIFY`

Tool to get Shopify integration contact lists and configuration. Use when retrieving Shopify integration settings or verifying connected contact lists for Shopify.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contact list summary

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_LIST_SUMMARY`

Tool to get summary details and performance metrics of a contact list. Use when you need to retrieve statistics and counts for a specific contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list to get summary for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Merge List

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_MERGE_LIST`

Tool to retrieve a list of contact lists that can be merged with a specified list. Use when you need to find compatible lists for merging contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | ID of the contact list to get merge list information for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Report History

**Slug:** `BENCHMARK_EMAIL_GET_CONTACT_REPORT_HISTORY`

Tool to get engagement history for a specific contact by email address. Use when you need to review which campaigns a contact has interacted with and their engagement metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of records to return per page |
| `page_number` | integer | No | Page number for pagination (1-based index) |
| `contact_email` | string | Yes | Email address of the contact to retrieve report history for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts Count

**Slug:** `BENCHMARK_EMAIL_GET_CONTACTS_COUNT`

Tool to get the count of contacts in specified lists and segments. Use when you need to know how many contacts exist in particular lists or segments without retrieving the full contact data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | Comma-separated IDs of the lists to count contacts from. Use '0' to count from all lists. |
| `segment_ids` | string | Yes | Comma-separated IDs of the segments to count contacts from. Use '0' to count from all segments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Filtered Contacts in List

**Slug:** `BENCHMARK_EMAIL_GET_CONTACTS_IN_LIST`

Tool to fetch filtered and paginated contacts from a list by ListID. Use when narrowing a list via search, filters, and paging.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Filter` | string ("2" | "5" | "100") | No | Subset filter: 2=unsubscribe, 5=hard bounce, 100=others. |
| `ListID` | string | Yes | ID of the contact list to query. |
| `OrderBy` | string ("email" | "firstname" | "lastname" | "date") | No | Field to sort by. |
| `PageSize` | integer | No | Number of contacts per page. |
| `SortOrder` | string ("asc" | "desc") | No | Sort direction. |
| `PageNumber` | integer | No | Pagination page number (starting at 1). |
| `SearchType` | string ("1" | "2" | "3" | "4") | No | Match type: 1=starts, 2=exact, 3=contains, 4=ends. |
| `SearchField` | string | No | Field to apply search (e.g., email, firstname). |
| `SearchFilter` | string | No | Text filter to search within contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Email at Time of Reset

**Slug:** `BENCHMARK_EMAIL_GET_CURRENT_EMAIL_AT_TIME_OF_RESET`

Tool to get the current email address at the time of a reset request. Use when verifying the email associated with a password reset or email change operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `GUID` | string | No | Unique ID for the reset request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Delete List Check

**Slug:** `BENCHMARK_EMAIL_GET_DELETE_LIST_CHECK`

Tool to check if contact lists can be deleted. Use before attempting to delete lists to verify deletion eligibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | Comma-separated list of contact list IDs to check for deletion eligibility |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Details About Archive Page

**Slug:** `BENCHMARK_EMAIL_GET_DETAILS_ABOUT_ARCHIVE_PAGE`

Tool to get details about the archive page including URLs, share settings, and domain. Use when you need to retrieve archive page configuration and URLs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Details Of Poll

**Slug:** `BENCHMARK_EMAIL_GET_DETAILS_OF_POLL`

Tool to retrieve details of a specific poll by ID. Use when you need information about a poll including its question, embed code, and share links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poll_id` | string | Yes | Unique identifier of the poll to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Digioh Username

**Slug:** `BENCHMARK_EMAIL_GET_DIGIOH_USERNAME`

Tool to get Digioh username for the authenticated account. Use when checking Digioh integration status or retrieving the associated username.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get DMARC List

**Slug:** `BENCHMARK_EMAIL_GET_DMARC_LIST`

Tool to retrieve DMARC (Domain-based Message Authentication, Reporting & Conformance) list for the client account. Use when you need to view domain authentication records.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Download Report

**Slug:** `BENCHMARK_EMAIL_GET_DOWNLOAD_REPORT`

Tool to get download report for a contact list. Use when you need to retrieve the download URL or status for a specific contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | ID of the contact list to get download report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get download segment data

**Slug:** `BENCHMARK_EMAIL_GET_DOWNLOAD_SEGMENT_DATA`

Tool to retrieve segment data for download. Use when you need to export or download contact data from a specific segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Unique identifier of the segment to download data from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get eBay Seller ID

**Slug:** `BENCHMARK_EMAIL_GET_EBAY_SELLER_ID`

Tool to get the eBay Seller ID for the authenticated account. Use when retrieving eBay integration details or verifying eBay connection status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get eBay Site List

**Slug:** `BENCHMARK_EMAIL_GET_EBAY_SITE_LIST`

Tool to retrieve a list of available eBay sites for integration. Use when you need to get eBay site options for connecting eBay accounts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Integration Connection List

**Slug:** `BENCHMARK_EMAIL_GET_EDITOR_INTEGRATION_CONNECTION_LIST`

Tool to retrieve the list of editor integration connections. Use when you need to view or list connected integrations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get email campaign details

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_DETAILS`

Tool to get details for a specific email campaign by ID. Use when needing campaign information such as subject, sender, schedule, and contact lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (ID) of the email campaign to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Opens by Country and Region

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_OPENS_BY_COUNTRY_REGION`

Tool to get a list of contacts who opened an email from a specific country and region. Use when you need geographic engagement data for email campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `region` | string | Yes | Two-letter region/state code (e.g., 'CA' for California, 'NY' for New York) |
| `country` | string | Yes | Two-letter country code (e.g., 'US', 'GB', 'CA') |
| `email_id` | string | Yes | Unique identifier of the email campaign |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Preview

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_PREVIEW`

Tool to get the preview of an email campaign. Use when you need to view the email content before sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | The unique identifier of the email campaign to preview |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Recipient Count

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_RECIPIENT_COUNT`

Tool to get the recipient count for an email campaign. Use when you need to know how many contacts will receive or have received a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | The unique identifier of the email campaign to get the recipient count for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Report

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_REPORT`

Tool to get email reports with pagination and filtering options. Use when you need to retrieve a list of email campaign reports.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ab_filter` | string | No | AB Filter for email reports to filter by A/B test campaigns |
| `page_size` | integer | No | Number of records to show per page |
| `filter_type` | string | No | Type of filter to apply to email reports |
| `page_number` | integer | No | Page number for pagination (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Report Forwards

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_REPORT_FORWARDS`

Tool to get forwards report for an email campaign. Use after campaign send to export its forwards.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the forwards report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unopens Report

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_REPORT_UNOPENS`

Tool to get unopens report for an email campaign by ID. Use when you need to export or review recipients who did not open a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Unique identifier of the email campaign |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Spam Check

**Slug:** `BENCHMARK_EMAIL_GET_EMAIL_SPAM_CHECK`

Tool to check spam score for an email campaign by ID. Use when you need to verify if an email campaign passes spam filters before sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Unique identifier of the email campaign to check for spam |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Etsy Store Name

**Slug:** `BENCHMARK_EMAIL_GET_ETSY_STORE_NAME`

Tool to get the connected Etsy store name. Use when verifying Etsy integration status or retrieving store details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Eventbrite Username

**Slug:** `BENCHMARK_EMAIL_GET_EVENTBRITE_USERNAME`

Tool to get the Eventbrite username associated with the Benchmark Email account. Use when verifying Eventbrite integration status or retrieving connected username.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Facebook Account Holder

**Slug:** `BENCHMARK_EMAIL_GET_FACEBOOK_ACCOUNT_HOLDER`

Tool to get Facebook account holder information. Use when you need to retrieve details about the connected Facebook account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Facebook Account Name

**Slug:** `BENCHMARK_EMAIL_GET_FACEBOOK_ACCOUNT_NAME`

Tool to get the Facebook account name from Facebook Events integration. Use when retrieving the connected Facebook account information.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Filtered Contacts with Extra Fields

**Slug:** `BENCHMARK_EMAIL_GET_FILTERED_CONTACTS_WITH_EXTRA_FIELDS`

Tool to fetch filtered and paginated contacts with custom/extra fields from a list by ListID. Use when you need contact data including custom field values along with standard contact information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Filter` | string ("2" | "5" | "100") | No | Subset filter: 2=unsubscribed, 5=hard bounce, 100=others. |
| `ListID` | string | Yes | ID of the contact list to query. |
| `OrderBy` | string | No | Field to sort by (e.g., email, firstname, lastname, date). |
| `PageSize` | integer | No | Number of contacts per page. |
| `SortOrder` | string ("asc" | "desc") | No | Sort direction: asc=ascending, desc=descending. |
| `PageNumber` | integer | No | Pagination page number (starting at 1). |
| `SearchType` | string ("1" | "2" | "3" | "4") | No | Match type: 1=starts with, 2=exact match, 3=contains, 4=ends with. |
| `SearchField` | string | No | Field to apply search filter (e.g., email, firstname, lastname). |
| `SearchFilter` | string | No | Text filter to search within contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Forwards Report By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_FORWARDS_REPORT_BY_EMAIL_ID`

Tool to get forwards report for an email campaign by ID. Use when you need to retrieve the list of contacts who forwarded a specific email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve forwards report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Full Report of Survey

**Slug:** `BENCHMARK_EMAIL_GET_FULL_REPORT_OF_SURVEY`

Tool to retrieve the full report of a survey including all responses and answers. Use when you need to analyze survey results and response data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `survey_id` | string | Yes | Unique identifier of the survey to retrieve the full report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HTML for Archive Newsletter

**Slug:** `BENCHMARK_EMAIL_GET_HTML_FOR_ARCHIVE_NEWSLETTER`

Tool to get HTML content for an archive newsletter by domain and URL. Use when you need to retrieve the HTML content of an archived email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Domain` | string | Yes | The archive domain to retrieve HTML from |
| `ArchiveURL` | string | Yes | The archive URL to retrieve HTML content for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HTML for Button

**Slug:** `BENCHMARK_EMAIL_GET_HTML_FOR_BUTTON`

Tool to get HTML content for a button URL from the archive. Use when you need to retrieve the HTML markup for a specific button by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string | Yes | ID of the button selected for archive. This identifier determines which button HTML to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HTML Signup Form

**Slug:** `BENCHMARK_EMAIL_GET_HTML_SIGNUP_FORM`

Tool to retrieve HTML and JavaScript embed code for a Tumbler signup form. Use when you need to get the complete embed code including jQuery dependencies and colorbox popup functionality for newsletter signup integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_builder_id` | string | Yes | ID of the signup form to retrieve HTML/JavaScript embed code for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get image details

**Slug:** `BENCHMARK_EMAIL_GET_IMAGE_DETAILS`

Tool to get details of a specific image by its ID. Use when retrieving information about a single image including its URL, size, and dates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ImageID` | string | Yes | Unique identifier of the image to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image for Button

**Slug:** `BENCHMARK_EMAIL_GET_IMAGE_FOR_BUTTON`

Tool to get HTML code for an 'Image' style archive button. This returns a pre-defined HTML snippet with an embedded image button for newsletter archive access. Similar to GetHtmlForButton but specifically returns the 'Image' button style variant.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inbox Detail Result

**Slug:** `BENCHMARK_EMAIL_GET_INBOX_DETAIL_RESULT`

Tool to get inbox detail test statistics including total purchases, tests used, and remaining balance. Use when you need to check inbox testing capacity and usage.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inbox List

**Slug:** `BENCHMARK_EMAIL_GET_INBOX_LIST`

Tool to retrieve inbox list with optional filtering and pagination. Use when you need to list or search inbox entries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter text to match inbox attributes |
| `status` | string ("0" | "1") | No | Filter by completion status: '1' for completed, '0' for not completed |
| `order_by` | string | No | Field name to sort results by |
| `page_size` | integer | No | Number of inbox entries to return per page |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: 'asc' for ascending or 'desc' for descending |
| `page_number` | integer | No | Page number to retrieve (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get inbox master result

**Slug:** `BENCHMARK_EMAIL_GET_INBOX_MASTER_RESULT`

Tool to get Inbox Master Result by ID. Use when retrieving inbox information for a specific inbox identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the inbox to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Individual Question Result Detail in Survey

**Slug:** `BENCHMARK_EMAIL_GET_INDIVIDUAL_QUESTION_RESULT_DETAIL_IN`

Tool to get individual question result details for a specific respondent in a survey by email address. Use when retrieving detailed survey response data for a single participant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `EmailID` | string | Yes | Email address of the individual respondent to retrieve results for |
| `SurveyID` | string | Yes | Unique identifier of the survey to retrieve results from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Integration Authorization URL

**Slug:** `BENCHMARK_EMAIL_GET_INTEGRATION_AUTH_URL`

Tool to get the OAuth authorization URL for integrating with third-party platforms. Use when setting up integrations with services like SurveyMonkey, EventBrite, Instagram, Facebook, or Twitter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `AuthSite` | string ("SM" | "EB" | "I" | "FB" | "FBE" | "T") | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get layout list

**Slug:** `BENCHMARK_EMAIL_GET_LAYOUT_LIST`

Tool to retrieve a list of email layouts. Use when you need to list or select a layout for email campaigns.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linked Agency Account Details

**Slug:** `BENCHMARK_EMAIL_GET_LINK_ACCOUNT_DETAILS`

Tool to get details of a linked agency account. Use when retrieving info for a specific linked account by ID after confirming the account exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | integer | Yes | ID of the linked agency account to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Link Detail By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_LINK_DETAIL_BY_EMAIL_ID`

Tool to get link detail report for an email campaign by ID. Use when you need to retrieve detailed link click statistics for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | integer | No | Optional filter parameter - ID of the specific link to retrieve details for |
| `email_id` | string | Yes | ID of the email campaign to retrieve the link detail report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Token

**Slug:** `BENCHMARK_EMAIL_GET_LINKED_IN_TOKEN`

Tool to get LinkedIn integration token information. Use when checking LinkedIn connection status or retrieving LinkedIn token details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Linked Agency Accounts

**Slug:** `BENCHMARK_EMAIL_GET_LIST_LINK_ACCOUNTS`

Tool to get list of linked agency accounts. Use after linking agency accounts to retrieve all associated accounts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get list mapping

**Slug:** `BENCHMARK_EMAIL_GET_LIST_MAPPING`

Tool to get the field mapping of an uploaded contact list file. Use when you need to retrieve how the uploaded file fields are mapped to Benchmark Email list fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | Unique identifier of the contact list |
| `file_name` | string | Yes | Name of the uploaded file to retrieve mapping for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List of Confirmed Emails

**Slug:** `BENCHMARK_EMAIL_GET_LIST_OF_CONFIRMED_EMAILS`

Tool to retrieve a list of confirmed email addresses for the client account. Use when you need a simple list of confirmed emails without detailed metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List of Emails

**Slug:** `BENCHMARK_EMAIL_GET_LIST_OF_EMAILS`

Tool to retrieve all email campaigns with optional filters and pagination. Use when you need to list, search, or select an email campaign.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get list of Giphy images

**Slug:** `BENCHMARK_EMAIL_GET_LIST_OF_GIPHY_IMAGES`

Tool to retrieve a list of Giphy images. Use when you need to list or search Giphy images available in the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter criteria to narrow down the Giphy images list |
| `page_size` | string | No | Number of records per page |
| `page_number` | string | No | Page number to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List of Help Topics

**Slug:** `BENCHMARK_EMAIL_GET_LIST_OF_HELP_TOPICS`

Tool to retrieve help topics from Benchmark Email. Use when you need to browse or search available help resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | string | No | Number of records to return per page (string format) |
| `filter_url` | string | No | URL filter to match help topics |
| `page_number` | string | No | Page number to retrieve (string format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List of Polls

**Slug:** `BENCHMARK_EMAIL_GET_LIST_OF_POLLS`

Tool to retrieve a list of polls. Use when you need to list or search polls from the account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter criteria to narrow down the polls list |
| `status` | string | No | Filter by poll status |
| `order_by` | string | No | Order by column |
| `page_size` | string | No | Number of rows on the page |
| `sort_order` | string | No | Sequence of order (e.g., ASC or DESC) |
| `page_number` | string | No | Page number to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List of Shopify Products

**Slug:** `BENCHMARK_EMAIL_GET_LIST_SHOPIFY_PRODUCTS`

Tool to get a list of Shopify products in HTML format. Use when you need to retrieve Shopify product data for integration purposes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List Upload Terms

**Slug:** `BENCHMARK_EMAIL_GET_LIST_UPLOAD_TERMS`

Tool to get list upload terms from Benchmark Email. Use when retrieving terms and conditions for list uploads.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Magento HTML dropdown

**Slug:** `BENCHMARK_EMAIL_GET_MAGENTO_HTML_DROP`

Tool to get Magento signup form dropdown HTML. Use when integrating Magento with email marketing campaigns.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Magento HTML Selected

**Slug:** `BENCHMARK_EMAIL_GET_MAGENTO_HTML_SELECTED`

Tool to retrieve Magento HTML code for a selected signup form. Use when you need to get the HTML and JavaScript code to integrate a Benchmark Email signup form with a Magento store's newsletter subscription.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_builder_id` | string | Yes | ID of the signup form/listbuilder to get Magento HTML for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Non Contact Count

**Slug:** `BENCHMARK_EMAIL_GET_NON_CONTACT_COUNT`

Tool to get the count of non-contacts based on email IDs and filter criteria. Use when you need to count recipients who are not in the contact list for specific campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `FilterType` | string | Yes | Filter type for the query. Use '1' for Any filter type |
| `EmailIDList` | string | No | Comma-separated list of Email IDs to check for non-contacts |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get notification

**Slug:** `BENCHMARK_EMAIL_GET_NOTIFICATION`

Tool to get client notifications from Benchmark Email. Use when checking for account alerts or messages.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Open Contact Count

**Slug:** `BENCHMARK_EMAIL_GET_OPEN_CONTACT_COUNT`

Tool to get the count of contacts who opened specified email campaigns. Use when you need to retrieve engagement metrics for email campaigns by counting unique contacts who opened one or more emails.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter_type` | string | No | Filter type for the query. Use '1' for Any (default). |
| `email_id_list` | string | Yes | Comma-separated list of email IDs to query for open contact counts |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Opens Hourly Report By Email

**Slug:** `BENCHMARK_EMAIL_GET_OPENS_HOURLY_REPORT_BY_EMAIL`

Tool to get hourly opens report for an email campaign by ID. Use when you need to analyze the hour-by-hour pattern of email opens for a specific campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the hourly opens report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Opens Location Report

**Slug:** `BENCHMARK_EMAIL_GET_OPENS_LOCATION_REPORT`

Tool to get a list of contacts by location for an email campaign's opens. Use when you need geographic distribution data of email opens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Unique identifier of the email campaign |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Opens Location Report By Email

**Slug:** `BENCHMARK_EMAIL_GET_OPENS_LOCATION_REPORT_BY_EMAIL`

Tool to get a list of contacts who opened an email from a specific country. Use when you need geographic engagement data for email campaigns by country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Unique identifier of the email campaign |
| `country_code` | string | Yes | Two-letter country code (e.g., 'US', 'GB', 'CA') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Opens Report

**Slug:** `BENCHMARK_EMAIL_GET_OPENS_REPORT`

Tool to get opens report for an email campaign by ID. Use when you need to retrieve information about contacts who opened a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the opens report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Partner Profile Details

**Slug:** `BENCHMARK_EMAIL_GET_PARTNER_PROFILE_DETAILS`

Tool to get partner profile details including company information and payment settings. Use when you need to fetch partner account configuration and payment preferences.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PayPal Integration Link

**Slug:** `BENCHMARK_EMAIL_GET_PAYPAL_LINK`

Tool to retrieve the PayPal integration callback URL for a specific contact list. Use when you need to get the PayPal integration link for a list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ContactMasterID` | string | Yes | The ID of the contact list to get the PayPal integration URL for. This ID can be obtained from the GET /Integration/Paypal endpoint which returns a list of all contact lists with their IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PayPal Contact Lists

**Slug:** `BENCHMARK_EMAIL_GET_PAYPAL_LISTS`

Tool to get contact lists formatted for PayPal integration. Returns HTML select dropdown with available contact lists.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Pinterest Username

**Slug:** `BENCHMARK_EMAIL_GET_PINTEREST_USERNAME`

Tool to retrieve the Pinterest username associated with the Benchmark Email account. Use when checking Pinterest integration status or fetching connected Pinterest username.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Poll Response Report

**Slug:** `BENCHMARK_EMAIL_GET_POLL_RESPONSE_REPORT`

Tool to retrieve the response report of a poll by ID. Use when you need to analyze poll results and response data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poll_id` | string | Yes | Unique identifier of the poll to retrieve response report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Preview of a Poll

**Slug:** `BENCHMARK_EMAIL_GET_PREVIEW_OF_A_POLL`

Tool to get a preview/render of a poll by its ID. Use when you need to see how a poll will appear.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poll_id` | string | Yes | Unique identifier of the poll to preview |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get referrals level 1 list

**Slug:** `BENCHMARK_EMAIL_GET_REFERRALS_LEVEL1_LIST`

Tool to get level 1 referrals list for a specific month and year. Use when you need to retrieve partner referral data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order for the referrals list. Specify sorting criteria if needed |
| `iyear` | string | Yes | Year in 4-digit format (e.g., '2024', '2025', '2026') |
| `imonth` | string | Yes | Month in 2-digit format (e.g., '01' for January, '12' for December) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Referrals List

**Slug:** `BENCHMARK_EMAIL_GET_REFERRALS_LIST`

Tool to retrieve the list of partner referrals. Use when you need to view referral information for commission tracking.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Answer Comment in Survey

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_ANSWER_COMMENT_IN_SURVEY`

Tool to retrieve comment answers from a survey report for a specific question. Use when analyzing open-ended or comment-type responses from survey participants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `survey_id` | string | Yes | Unique identifier of the survey to retrieve comment answers from |
| `question_id` | string | No | Optional ID of the specific question to filter comment answers. If not provided, returns all comment answers for the survey. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Answer Other in Survey

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_ANSWER_OTHER_IN_SURVEY`

Tool to retrieve 'other' text answers from survey questions that have an 'other' option. Use when you need to analyze free-text responses that don't fit predefined answer choices.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `survey_id` | string | Yes | Unique identifier of the survey to retrieve 'other' answers from |
| `question_id` | string | No | Optional ID of the specific question to filter 'other' answers. If not provided, returns all 'other' answers for the survey. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Answer Text in Survey

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_ANSWER_TEXT_IN_SURVEY`

Tool to retrieve text answers from survey questions. Use when you need to analyze free-text responses to survey questions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `survey_id` | string | Yes | Unique identifier of the survey to retrieve text answers from |
| `question_id` | string | No | Optional ID of the specific question to filter text answers. If not provided, returns all text answers for the survey. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Details By AB Test

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_DETAILS_BY_AB_TEST`

Tool to get report details for a specific AB split test by ID and ABID. Use when you need to retrieve detailed metrics and statistics for a particular A/B test campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Final Unique ID of the email campaign |
| `abid` | string | Yes | ABSplit ID for the AB test |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Details By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_DETAILS_BY_EMAIL_ID`

Tool to get detailed report summary for an email campaign by ID. Use when you need to review performance metrics like opens, clicks, bounces, and unsubscribes for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Unique identifier of the email campaign to retrieve report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report Download

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_DOWNLOAD`

Tool to download email campaign report by type. Use when you need to export clicks, forwards, bounces, complaints, or unsubscribe data for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the report for |
| `report_type` | string ("clicks" | "forwards" | "bounces" | "complaints" | "unsubscribes" | "clicks_alt") | Yes | Type of report to download: clicks (1 or 8), forwards (2), bounces (3), complaints (4), or unsubscribes (5) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report List of Survey

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_LIST_OF_SURVEY`

Tool to retrieve a paginated list of survey reports. Use when you need to view or analyze survey report data across multiple surveys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter survey reports by survey name |
| `order_by` | string | No | Column name to sort by |
| `page_size` | integer | No | Number of survey reports to return per page |
| `sort_order` | string ("asc" | "desc") | No | Sort direction: 'asc' for ascending or 'desc' for descending |
| `page_number` | integer | No | Page number to retrieve (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Report of Survey Individual Result

**Slug:** `BENCHMARK_EMAIL_GET_REPORT_OF_SURVEY_INDIVIDUAL_RESULT`

Tool to retrieve paginated individual survey results showing who responded and when. Use when you need to list all survey participants and their response metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter criteria to apply to the results |
| `order_by` | string | No | Field name to sort results by |
| `page_size` | integer | No | Number of records to show per page |
| `survey_id` | string | Yes | Unique identifier of the survey to retrieve individual results for |
| `sort_order` | string | No | Sort direction: 'asc' for ascending or 'desc' for descending |
| `page_number` | integer | No | Page number for pagination (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reports for Autoresponders

**Slug:** `BENCHMARK_EMAIL_GET_REPORTS_FOR_AUTORESPONDERS`

Tool to get reports for autoresponders with pagination and filtering options. Use when you need to retrieve automation campaign reports or analyze autoresponder performance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter for autoresponders to narrow down report results |
| `page_size` | integer | No | Number of records to show per page |
| `page_number` | integer | No | Page number for pagination (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resend Confirm Email

**Slug:** `BENCHMARK_EMAIL_GET_RESEND_CONFIRM_EMAIL`

Tool to resend confirmation email to a specific email address. Use when an email address needs to receive a new confirmation link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to resend the confirmation email to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get RSS History By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_RSS_HISTORY_BY_EMAIL_ID`

Tool to get RSS history for an email campaign by ID. Use when you need to retrieve RSS feed history for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the RSS history for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Salesforce Integration Status

**Slug:** `BENCHMARK_EMAIL_GET_SALESFORCE_INTEGRATION`

Tool to get Salesforce integration status and details from Benchmark Email account. Use when checking if Salesforce CRM is connected.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get save as list

**Slug:** `BENCHMARK_EMAIL_GET_SAVE_AS_LIST`

Tool to retrieve save-as-list data with optional filters. Use when you need to query lists that were saved from email campaigns, events, or AB tests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ABID` | string | No | ID of the AB Test to filter by |
| `r_type` | string | No | Type filter for the query |
| `email_id` | string | No | ID of the Email to filter by |
| `event_id` | string | No | ID of the Event to filter by |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Scheme

**Slug:** `BENCHMARK_EMAIL_GET_SCHEME`

Tool to retrieve color schemes with optional filtering. Use when fetching default or saved color schemes for email templates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Filter` | string | No | Filter type: 'default' for default schemes or 'saved' for user-saved schemes |
| `Language` | string | No | Language filter for schemes |
| `FilterType` | string | No | Filter type parameter for additional filtering |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segment Auto Generate Name

**Slug:** `BENCHMARK_EMAIL_GET_SEGMENT_AUTO_GENERATE_NAME`

Tool to get an auto-generated segment name for a list. Use when creating segments to get a default name suggestion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list to generate a segment name for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segment by ID

**Slug:** `BENCHMARK_EMAIL_GET_SEGMENT_BY_ID`

Tool to retrieve details of a specific contact segment by its ID. Use when you need to get information about a particular segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | string | Yes | Unique identifier of the segment to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segment Details

**Slug:** `BENCHMARK_EMAIL_GET_SEGMENT_DETAILS`

Tool to retrieve contact details from a specific segment with optional filtering, pagination, and sorting. Use when you need to access the contacts within a segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_by` | string | No | Field to order results by (e.g., 'Email', 'FirstName', 'LastName', 'CreatedDate'). |
| `page_size` | integer | No | Number of contacts to return per page. |
| `segment_id` | string | Yes | Unique identifier of the segment to retrieve details for. |
| `sort_order` | string | No | Sort direction: 'asc' for ascending or 'desc' for descending. |
| `page_number` | integer | No | Page number for pagination (starting at 1). If not specified, returns first page. |
| `search_type` | string | No | Match type for search: '1'=starts with, '2'=exact match, '3'=contains, '4'=ends with. |
| `search_field` | string | No | Field to apply search filter on (e.g., 'Email', 'FirstName', 'LastName'). |
| `search_filter` | string | No | Text filter to search within segment contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segment List

**Slug:** `BENCHMARK_EMAIL_GET_SEGMENT_LIST`

Tool to retrieve segment lists for a specific contact list by ListID. Use when you need to get all segments associated with a particular contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | ID of the contact list to retrieve segments for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segments

**Slug:** `BENCHMARK_EMAIL_GET_SEGMENTS`

Tool to retrieve a paginated list of contact segments. Use when you need to list or find segments with optional filtering and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | Yes | Filter value to search segments by name or other attributes. Use empty string for no filtering. |
| `order_by` | string | Yes | Field to order results by (e.g., 'Name', 'CreatedDate', 'ModifiedDate', 'ContactCount'). |
| `page_size` | integer | Yes | Number of segments to return per page. Required parameter. |
| `page_number` | integer | No | Page number for pagination (starting at 1). If not specified, returns first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shopify Product List Tabular

**Slug:** `BENCHMARK_EMAIL_GET_SHOPIFY_PRODUCT_LIST_TABULAR`

Tool to get Shopify product list in tabular (HTML) format. Use when you need to retrieve product data from a Shopify integration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signup Form Button Code

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUP_FORM_BUTTON_CODE`

Tool to get the code for the signup form button. Use when you need to retrieve the HTML/JavaScript code snippet for embedding a signup form button on a website.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Signup Form ID |
| `Language` | string | No | Language for the signup form button code |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signup Form Contact Fields

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUP_FORM_CONTACT_FIELDS`

Tool to get the contact fields of a signup form by ID. Use when you need to retrieve the list of contact fields configured for a specific signup form.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Unique identifier of the signup form to retrieve contact fields for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signup Form Details

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUP_FORM_DETAILS`

Tool to get details for a specific signup form by ID. Use when needing information about a signup form's configuration and associated contact lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Unique identifier of the signup form to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SignupForm for Magento

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUPFORM_FOR_MAGENTO`

Tool to get SignupForm data for Magento integration. Use when you need to retrieve signup form configuration for integrating with a Magento store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | No | Listbuilder ID to retrieve specific signup form data for Magento |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SignupForm For Unbounce

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUPFORM_FOR_UNBOUNCE`

Tool to retrieve signup form integration data for Unbounce. Use when you need to get the Unbounce integration URL or configuration for a specific contact master ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | ContactMaster ID - required to get meaningful Unbounce integration results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signup Form Link

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUP_FORM_LINK`

Tool to get the link URL for a specific signup form. Use when needing the public URL for a signup form to share or embed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Unique identifier of the signup form to get the link for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signup Form List

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUP_FORM_LIST`

Tool to retrieve all signup forms (listbuilder forms). Use when you need to list available signup forms for the account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signup Forms for Contact List

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUP_FORM_LIST_CONTACT`

Tool to get a list of signup forms associated with a specific contact list. Use when needing to identify which signup forms feed into a particular contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | ID of the contact list to retrieve associated signup forms |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SignupForm Tumbler

**Slug:** `BENCHMARK_EMAIL_GET_SIGNUP_FORM_TUMBLER`

Tool to get third-party SignupForm Tumbler query string parameters. Use when you need to retrieve Tumbler integration parameters for a signup form.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | No | Listbuilder ID to filter the Tumbler signup form |
| `Email` | string | No | Email field parameter |
| `Title` | string | No | Title text to filter by |
| `Language` | string | No | Language code to filter by |
| `Subscribe` | string | No | Subscribe button text or parameter |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Social Performance Report

**Slug:** `BENCHMARK_EMAIL_GET_SOCIAL_PERFORMANCE_REPORT`

Tool to get social performance report for an email campaign by ID. Use when you need to retrieve social sharing metrics and statistics for a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the social performance report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get sub-account balance

**Slug:** `BENCHMARK_EMAIL_GET_SUB_ACCOUNT_BALANCE`

Tool to get the balance (plan limit) for a specific sub-account by ID. Use when needing to check the contact limit or plan balance of a child account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (ID) of the sub-account to retrieve balance for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get sub-account details

**Slug:** `BENCHMARK_EMAIL_GET_SUB_ACCOUNT_DETAILS`

Tool to get details for a specific sub-account by ID. Use when needing profile and plan info of a child account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (ID) of the sub-account to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sub-Account History

**Slug:** `BENCHMARK_EMAIL_GET_SUB_ACCOUNT_HISTORY`

Tool to get sub-account history. Use after listing sub-accounts to retrieve each account's billing history.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get sub-account history details

**Slug:** `BENCHMARK_EMAIL_GET_SUB_ACCOUNT_HISTORY_DETAILS`

Tool to get detailed history information for a specific sub-account billing cycle. Use when you need billing cycle details for a particular history record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | No | History ID (query parameter, optional) |
| `EndDate` | string | No | Billing cycle end date |
| `HistoryID` | string | Yes | Unique identifier of the history record to retrieve |
| `StartDate` | string | No | Billing cycle start date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sub-Accounts

**Slug:** `BENCHMARK_EMAIL_GET_SUB_ACCOUNTS`

Tool to retrieve all sub-accounts for the client. Use when you need to view or manage sub-accounts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sub-Accounts Plan List

**Slug:** `BENCHMARK_EMAIL_GET_SUB_ACCOUNTS_PLAN_LIST`

Tool to retrieve available plans for a sub-account. Use when you need to determine list and email limits for a specific sub-account client ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Sub-account holder client ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Survey Details

**Slug:** `BENCHMARK_EMAIL_GET_SURVEY_DETAILS`

Tool to retrieve details of a specific survey by ID. Use when you need information about a survey including its questions and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `survey_id` | string | Yes | Unique identifier of the survey to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get survey report detail

**Slug:** `BENCHMARK_EMAIL_GET_SURVEY_REPORT_DETAIL`

Tool to get detailed report of a survey including questions, responses, and response counts. Use when needing survey analytics and response data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `SurveyID` | string | Yes | Unique identifier of the survey to retrieve report details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get template by template ID

**Slug:** `BENCHMARK_EMAIL_GET_TEMPLATE_BY_TEMPLATE_ID`

Tool to get details for a specific email template by ID. Use when needing template information such as name, subject, content, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Unique identifier of the template to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get template category by ID

**Slug:** `BENCHMARK_EMAIL_GET_TEMPLATE_CATEGORY_BY_CATEGORY_ID`

Tool to get details for a specific email template category by ID. Use when needing information about a template category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | Optional language code for the template category (e.g., 'en', 'es') |
| `category_id` | string | Yes | Unique identifier of the template category to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template Category List

**Slug:** `BENCHMARK_EMAIL_GET_TEMPLATE_CATEGORY_LIST`

Tool to retrieve template category list with optional filters. Use when you need to browse or select email template categories.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `is_rss` | integer | No | RSS filter: 1 if RSS, 0 otherwise |
| `version` | integer | No | Version filter for categories |
| `language` | integer | No | Language filter for template categories |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template List of Survey

**Slug:** `BENCHMARK_EMAIL_GET_TEMPLATE_LIST_OF_SURVEY`

Tool to retrieve the list of survey templates. Use when you need to view available survey templates.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Templates

**Slug:** `BENCHMARK_EMAIL_GET_TEMPLATES`

Tool to retrieve email templates from Benchmark Email. Use when you need to list or select an email template for campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of templates to return per page |
| `page_number` | integer | No | Page number to retrieve (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Templates for Signup Form Classic

**Slug:** `BENCHMARK_EMAIL_GET_TEMPLATES_FOR_SIGNUP_FORM_CLASSIC`

Tool to retrieve templates for Signup Forms (Classic Only). Use when you need to list available signup form templates for the classic editor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Filter criteria to narrow down the templates list |
| `language` | string | No | Language code to filter templates (e.g., 'en', 'es', 'fr') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the clean count

**Slug:** `BENCHMARK_EMAIL_GET_THE_CLEAN_COUNT`

Tool to get the clean count for a contact list. Use when you need to retrieve clean count statistics for a specific list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ct` | string | No | Clean type filter parameter |
| `ctc` | string | No | Clean type category filter parameter |
| `ListID` | string | Yes | ID of the contact list to get clean count for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trash Count

**Slug:** `BENCHMARK_EMAIL_GET_TRASH_COUNT`

Tool to get the count of contacts in the trash. Use when you need to retrieve the number of deleted contacts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tumbler Lists

**Slug:** `BENCHMARK_EMAIL_GET_TUMBLER_LISTS`

Tool to get Tumbler signup form lists in HTML format. Use when you need to retrieve the list of signup forms for Tumbler integration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Twitter Login Status

**Slug:** `BENCHMARK_EMAIL_GET_TWITTER_LOGIN`

Tool to get Twitter login/integration status for the authenticated Benchmark Email account. Use when checking if Twitter is connected or retrieving Twitter account details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unbounce Link

**Slug:** `BENCHMARK_EMAIL_GET_UNBOUNCE_LINK`

Tool to get the Unbounce integration URL for a specific contact list. Use when you need to retrieve the Unbounce URL for integrating a contact list with Unbounce landing pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ContactMasterID` | string | Yes | ID of the contact list for which to generate the Unbounce integration URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unbounce Lists

**Slug:** `BENCHMARK_EMAIL_GET_UNBOUNCE_LISTS`

Tool to get Unbounce contact lists in HTML format. Use when integrating with Unbounce to retrieve available signup form lists.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get unique contact count

**Slug:** `BENCHMARK_EMAIL_GET_UNIQUE_COUNT`

Tool to get the total count of unique contacts in the account. Use when needing the unique contact count.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unopens Report By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_UNOPENS_REPORT_BY_EMAIL_ID`

Tool to get unopens report for an email campaign by ID. Use when you need to retrieve a list of contacts who did not open a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email campaign to retrieve the unopens report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unsubscribe Report By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_UNSUBSCRIBE_REPORT_BY_EMAIL_ID`

Tool to get unsubscribe report for an email campaign by ID. Use when you need to review recipients who unsubscribed from a specific email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Unique identifier of the email campaign to retrieve unsubscribe report for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get URL List By Email ID

**Slug:** `BENCHMARK_EMAIL_GET_URL_LIST_BY_EMAIL_ID`

Tool to get URL list for a specific email campaign by ID. Use when you need to retrieve all URLs included in an email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the email campaign to retrieve the URL list for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get URL Engagement List

**Slug:** `BENCHMARK_EMAIL_GET_URL_LIST_OF_ENGAGEMENT`

Tool to retrieve URL engagement statistics for email campaigns. Use when you need to analyze which URLs in your emails were clicked and their engagement metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Filter` | string | No | Filter text to match URL engagement records |
| `OrderBy` | string | No | Field name to sort results by |
| `EmailIDs` | string | No | Comma-separated list of Email IDs to filter engagement data |
| `PageSize` | integer | No | Number of records to return per page |
| `SortOrder` | string | No | Sort direction: 'asc' or 'desc' |
| `PageNumber` | integer | No | Page number to retrieve (1-based index) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Details

**Slug:** `BENCHMARK_EMAIL_GET_VIDEO_DETAILS`

Tool to get details for a specific video by its ID. Use when needing information about a video in the Benchmark Email account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `VideoID` | string | Yes | ID of the video to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhooks

**Slug:** `BENCHMARK_EMAIL_GET_WEBHOOKS`

Tool to retrieve all webhooks for a contact list. Use when you need to view or list webhooks configured for a specific list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | ID of the contact list to retrieve webhooks from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get web page ads detail

**Slug:** `BENCHMARK_EMAIL_GET_WEB_PAGE_ADS_DETAIL`

Tool to get web page ads detail from the Partner API. Use when you need to retrieve information about web page advertisements.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initiate Email Screen Capture

**Slug:** `BENCHMARK_EMAIL_INITIATE_EMAIL_SCREEN_CAPTURE`

Tool to initiate the screen capture process for an email campaign. Use when you need to generate a screen capture of a specific email by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | ID of the email to capture screen for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link Agency Account

**Slug:** `BENCHMARK_EMAIL_LINK_ACCOUNT`

Tool to link an agency account to your Benchmark Email account. Use when you need to connect and manage another account with the provided credentials.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Alias` | string | Yes | Alias name for the account |
| `Login` | string | Yes | Login ID / Email address for the account to link |
| `Password` | string | Yes | Password for the account to link |
| `FromEmailAddress` | string | Yes | From email address for the account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Log Out Twitter Tweets

**Slug:** `BENCHMARK_EMAIL_LOG_OUT_TWITTER_TWEETS`

Tool to log out of Twitter Tweets integration from Benchmark Email account. Use when removing Twitter Tweets posting integration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge Contacts Into Existing List

**Slug:** `BENCHMARK_EMAIL_MERGE_CONTACTS_INTO_EXISTING_LIST`

Tool to merge contacts from source list(s) into an existing target list. Use when you need to consolidate contacts from one or more lists into another list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | ID of the source contact list(s) to merge contacts from |
| `TargetListID` | string | Yes | ID of the target list to merge contacts into |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge Contacts Into New List

**Slug:** `BENCHMARK_EMAIL_MERGE_CONTACTS_INTO_NEW_LIST`

Tool to merge contacts from multiple lists into a new list. Use when you need to consolidate contacts from different lists into a single new list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `NewList` | string | Yes | Name for the new merged contact list |
| `list_ids` | string | Yes | Comma-separated IDs of the contact lists to merge. Format: '12345,67890' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Bulk Contacts

**Slug:** `BENCHMARK_EMAIL_MOVE_BULK_CONTACTS`

Tool to move contacts in bulk from a source list to one or more target lists. Use when you need to transfer contacts between lists, removing them from the source.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the source list containing contacts to move |
| `ContactIDs` | string | No | Optional comma-separated list of contact IDs to move. If not provided, all contacts from the source list will be moved. |
| `TargetListIDs` | string | Yes | Target List ID(s) as a string. Can be a single list ID or comma-separated list IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Contacts

**Slug:** `BENCHMARK_EMAIL_MOVE_CONTACTS`

Tool to move contacts from one list to another. Use when you need to relocate contacts between lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the source list containing the contacts to move |
| `contact_ids` | string | Yes | Comma-separated list of contact IDs to move |
| `target_list_id` | string | Yes | ID of the target list where contacts will be moved |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move Contact to Do Not Contact List

**Slug:** `BENCHMARK_EMAIL_MOVE_CONTACT_TO_DO_NOT_CONTACT`

Tool to move a contact to the Do Not Contact (Master Unsubscribe) list. Use when you need to permanently unsubscribe a contact from all communications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list from which to move the contact |
| `contact_id` | string | Yes | ID of the contact to move to the Do Not Contact list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add / Update Scheme

**Slug:** `BENCHMARK_EMAIL_PATCH_ADD_UPDATE_SCHEME`

Tool to add or update a color scheme. Use when creating new schemes or modifying existing ones with color hex codes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Identifier for the scheme |
| `Name` | string | Yes | Name of the color scheme |
| `Colors` | array | Yes | Array of color values (hex codes) for the scheme |
| `language` | string | No | Language parameter for the scheme |
| `overwrite` | integer | No | 1 to overwrite existing scheme, 0 to not overwrite existing scheme |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Password

**Slug:** `BENCHMARK_EMAIL_PATCH_CHANGE_PASSWORD`

Tool to change the password for the client account. Use when updating account credentials after validating new and confirm passwords match.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `NewPassword` | string | Yes | New password for the client account |
| `ConfirmPassword` | string | Yes | Confirmation of the new password; must match NewPassword |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Security PIN

**Slug:** `BENCHMARK_EMAIL_PATCH_SAVE_SECURITY_PIN`

Tool to save a new security PIN for the client account. Use when you need to update the account PIN after confirming both entries match.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `NewPIN` | string | Yes | New 4-digit security PIN to set for the client account |
| `ConfirmNewPIN` | string | Yes | Confirmation of the new PIN; must match NewPIN |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Reset Email

**Slug:** `BENCHMARK_EMAIL_PATCH_SEND_RESET_EMAIL`

Tool to send a reset email link to change the primary email address. Use when initiating an email-based reset of the account’s primary email after user request.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Update Client Settings

**Slug:** `BENCHMARK_EMAIL_PATCH_UPDATE_CLIENT_SETTINGS`

Tool to update client account settings. Use after fetching current settings. Updates company info, timezone, language, sender defaults, and signature details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Detail` | object | Yes | Detail object containing all settings to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact List

**Slug:** `BENCHMARK_EMAIL_PATCH_UPDATE_CONTACT_LIST`

Tool to update an existing contact list. Use after confirming list ID and desired modifications to name, description, labels, or custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Data` | object | Yes | Payload containing the fields to update |
| `ListID` | string | Yes | Identifier of the contact list to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update/Edit Profile

**Slug:** `BENCHMARK_EMAIL_PATCH_UPDATE_EDIT_PROFILE`

Tool to update or edit profile information such as first name, last name, and phone number. Use after retrieving profile details to apply changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `PhoneNo` | string | Yes | Client's phone number |
| `LastName` | string | Yes | Client's last name |
| `FirstName` | string | Yes | Client's first name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `BENCHMARK_EMAIL_PATCH_UPDATE_WEBHOOK`

Tool to update a webhook for a contact list by webhook ID. Use after retrieving or creating a webhook to modify its event settings such as cleaned-address, email-change, profile-update, subscribe, and unsubscribe callbacks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | integer | Yes | Unique identifier of the webhook to update |
| `Data` | object | Yes | Settings payload for the webhook |
| `ListID` | integer | Yes | ID of the contact list containing the webhook |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Contact to List

**Slug:** `BENCHMARK_EMAIL_POST_ADD_CONTACT_TO_LIST`

Tool to add a new contact to a specific list. Use after verifying the list ID exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Email` | string | Yes | Contact's email address |
| `ListID` | string | Yes | ID of the contact list to add the new contact to |
| `LastName` | string | No | Contact's last name (optional) |
| `EmailPerm` | string ("0" | "1") | No | Email permission flag: '1'=grant, '0'=decline (optional) |
| `FirstName` | string | No | Contact's first name (optional) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Product to List

**Slug:** `BENCHMARK_EMAIL_POST_ASSIGN_PRODUCT_LIST`

Tool to assign a Shopify product to a list where purchasers are added. Use when integrating Shopify purchases with email lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | The Benchmark Email list identifier where purchasers will be added |
| `ProductID` | string | Yes | The Shopify product identifier to assign to the list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Security PIN

**Slug:** `BENCHMARK_EMAIL_POST_CHANGE_SECURITY_PIN`

Tool to change security PIN for the client account. Use after confirming your current PIN to rotate your PIN.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ResetPIN` | string | Yes | New 4-digit security PIN to set for the client account |
| `ResetOldPIN` | string | Yes | Current 4-digit security PIN |
| `ResetConfirmPIN` | string | Yes | Confirmation of the new PIN; must match ResetPIN |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Poll

**Slug:** `BENCHMARK_EMAIL_POST_COPY_POLL`

Tool to copy an existing poll. Use when you need to duplicate a poll with a new name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | Name of the copied poll |
| `PollID` | string | Yes | ID of the poll to copy |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact List

**Slug:** `BENCHMARK_EMAIL_POST_CREATE_CONTACT_LIST`

Tool to create a new contact list. Use after planning list name and optional description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | Name of the new contact list |
| `Description` | string | No | Optional description for the contact list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Poll

**Slug:** `BENCHMARK_EMAIL_POST_CREATE_POLL`

Tool to create a new poll in Benchmark Email. Use when you need to create a poll for collecting responses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | Name of the poll |
| `PollID` | string | Yes | Unique identifier for the poll |
| `Question` | string | Yes | The poll question to be displayed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segment Criteria

**Slug:** `BENCHMARK_EMAIL_POST_CREATE_SEGMENT_CRITERIA`

Tool to create criteria for a segment. Use after confirming the segment ID exists and defining filter rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Data` | object | Yes | Criteria configuration containing match type, fetch type, and criteria rules |
| `SegmentID` | string | Yes | ID of the segment to add criteria to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `BENCHMARK_EMAIL_POST_CREATE_WEBHOOK`

Tool to create a new webhook for a contact list. Use when you need to get callbacks for list events after list creation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | ID of the contact list to associate the new webhook with |
| `ClientUrl` | string | Yes | The HTTP endpoint URL to receive webhook callbacks |
| `Subscribes` | string ("0" | "1") | Yes | Flag for subscribe event callback: '1' to enable, '0' to disable |
| `EmailChanged` | string ("0" | "1") | Yes | Flag for email-changed event callback: '1' to enable, '0' to disable |
| `Unsubscribes` | string ("0" | "1") | Yes | Flag for unsubscribe event callback: '1' to enable, '0' to disable |
| `CleanedAddress` | string ("0" | "1") | Yes | Flag for cleaned-address event callback: '1' to enable, '0' to disable |
| `ProfileUpdates` | string ("0" | "1") | Yes | Flag for profile-updates event callback: '1' to enable, '0' to disable |
| `ContactMasterID` | string | Yes | Same as ListID, the contact list identifier |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Disable Security PIN

**Slug:** `BENCHMARK_EMAIL_POST_DISABLE_SECURITY_PIN`

Tool to disable security PIN for the client account. Use when revoking the current PIN to remove PIN protection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `DisableOldPIN` | string | Yes | Current 4-digit security PIN to disable |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Login Redirect Using Token

**Slug:** `BENCHMARK_EMAIL_POST_LOGIN_REDIRECT_USING_TOKEN`

Tool to acquire a temporary token to an account. Use when you need to authenticate and get redirected to a specific path in the application using a token-based login.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `redir` | string | Yes | Redirect path after login (e.g., '/Contacts', '/Dashboard') |
| `token` | string | Yes | The authentication token value to use for login redirect |
| `remember-login` | string | Yes | Set to '1' to enable persistent login, '0' to disable |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Website Domain

**Slug:** `BENCHMARK_EMAIL_POST_SAVE_WEBSITE_DOMAIN`

Tool to save a website domain for your Benchmark Email account. Use after account setup to register your domain for link tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `CompanyWebsite` | string | Yes | Domain name to link with your Benchmark Email account (e.g., 'example.com'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Confirm Email Verification

**Slug:** `BENCHMARK_EMAIL_POST_SEND_CONFIRM_EMAIL_VERIFICATION`

Tool to send confirm email verification. Use when unverified addresses must receive verification emails after signup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `EmailIDs` | string | Yes | Comma-separated list of email addresses to send verification emails to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send PIN via Email

**Slug:** `BENCHMARK_EMAIL_POST_SEND_PIN_EMAIL`

Tool to send PIN via email. Use when you forgot your security PIN and need it emailed to you.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Configure Shopify Purchase List

**Slug:** `BENCHMARK_EMAIL_POST_SHOPIFY_PURCHASE_LIST`

Tool to configure Shopify purchase list integration. Use when setting up or updating the contact list for Shopify purchase tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ContactMasterID` | string | No | ID of the list to associate with Shopify purchases. If not provided, uses default configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resend Emails to Contacts

**Slug:** `BENCHMARK_EMAIL_RESEND_EMAILS`

Tool to resend confirmation emails to contacts in a specific list. Use when you need to resend verification or confirmation emails to contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | ID of the contact list to resend emails to |
| `ContactIDs` | string | Yes | Comma-separated string of contact IDs to resend confirmation emails to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Email From Trash

**Slug:** `BENCHMARK_EMAIL_RESTORE_EMAIL_FROM_TRASH`

Tool to restore an email from trash. Use when you need to recover a deleted email campaign by moving it out of trash.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | ID of the email to restore from trash |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Trash List

**Slug:** `BENCHMARK_EMAIL_RESTORE_TRASH_LIST`

Tool to restore deleted contact lists from trash. Use after confirming the list IDs to recover.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_ids` | string | Yes | IDs of the lists to restore from trash. Can be a single ID or comma-separated IDs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Email Address

**Slug:** `BENCHMARK_EMAIL_SAVE_EMAIL_ADDRESS`

Tool to save email address(es) to a contact list in CSV format. Use when you need to add or update email addresses in a specific list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ListID` | string | Yes | ID of the contact list to save email addresses to |
| `EmailIDs` | string | Yes | Email address(es) to save. Can be a single email or newline-separated list of emails for multiple addresses |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save Verified Email Addresses

**Slug:** `BENCHMARK_EMAIL_SAVE_VERIFIED_EMAIL_ADDRESSES`

Tool to save email addresses which have verified URLs to a contact list. Use when you need to mark specific email addresses as verified in a list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list to save verified email addresses to |
| `email_ids` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Schedule Email Campaign

**Slug:** `BENCHMARK_EMAIL_SCHEDULE_EMAIL`

Tool to schedule an email campaign for sending at a specific date and time. Use when you need to schedule a verified email campaign for future delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (ID) of the email campaign to schedule |
| `ScheduleDate` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contact Details by Email

**Slug:** `BENCHMARK_EMAIL_SEARCH_CONTACT_DETAILS_BY_EMAIL`

Tool to search for contact details by email address and show lists they belong to and status. Use when you need to find a contact's membership information across lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | Yes | Email address to search for in the contact database |
| `SearchFilter` | string | No | Optional text filter to narrow search results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Support Feedback

**Slug:** `BENCHMARK_EMAIL_SEND_SUPPORT_FEEDBACK`

Tool to send support feedback or inquiry to Benchmark Email support team. Use when users need to contact support with questions, issues, or feedback.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | Full name of the person submitting the support request |
| `Email` | string | Yes | Email address of the person submitting the request for follow-up communication |
| `Message` | string | Yes | Detailed message content describing the issue or question |
| `Subject` | string | Yes | Subject line of the support message |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Test Email for Signup Form

**Slug:** `BENCHMARK_EMAIL_SEND_TEST_EMAIL_FOR_SIGNUP_FORM`

Tool to send a test email for a signup form. Use when you need to test the signup form email configuration before going live.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Signup form ID to send test email for |
| `Message` | string | Yes | Message body content for the test email |
| `Subject` | string | Yes | Subject line for the test email |
| `ToEmail` | string | Yes | Recipient email address for the test email |
| `FromName` | string | Yes | From name for the test email |
| `FromEmail` | string | Yes | From email address for the test email |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Responsive

**Slug:** `BENCHMARK_EMAIL_SET_RESPONSIVE`

Tool to set the client's responsive status. Use when enabling or disabling responsive mode for the client account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `IsResponsive` | integer | Yes | Set responsive status: 1 = Responsive, 0 = Not Responsive |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Share Lists with SubAccounts

**Slug:** `BENCHMARK_EMAIL_SHARE_LISTS_WITH_SUBACCOUNTS`

Tool to share contact lists with sub-accounts. Use when you need to grant sub-accounts access to a specific list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the contact list to share |
| `client_ids` | string | Yes | Comma-separated client IDs of sub-accounts to share the list with |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Share Template to Sub-Accounts

**Slug:** `BENCHMARK_EMAIL_SHARE_TEMPLATE_TO_SUB_ACCOUNTS`

Tool to share an email template with sub-accounts. Use when distributing templates across sub-accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the email template to share |
| `SubAccount` | array | No | Array of sub-account IDs to share the template with. Pass an empty array to share with all sub-accounts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Share Video

**Slug:** `BENCHMARK_EMAIL_SHARE_VIDEO`

Tool to share/copy a video to other client accounts. Use when you need to duplicate a video across multiple client accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Clients` | string | Yes | Comma-separated string of client IDs to share the video to. Example: 'client1,client2' |
| `VideoID` | string | Yes | ID of the video to share/copy |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test eBay Integration

**Slug:** `BENCHMARK_EMAIL_TEST_EBAY_INTEGRATION`

Tool to test eBay integration and verify connection status. Use when validating eBay account connectivity and retrieving integration details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Etsy Integration

**Slug:** `BENCHMARK_EMAIL_TEST_ETSY_INTEGRATION`

Tool to test the Etsy integration connection with Benchmark Email. Use when verifying if the Etsy integration is properly configured and working.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Eventbrite Integration

**Slug:** `BENCHMARK_EMAIL_TEST_EVENTBRITE_INTEGRATION`

Tool to test the Eventbrite integration connection with Benchmark Email. Use when verifying if Eventbrite is properly connected and syncing.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Facebook Events Integration

**Slug:** `BENCHMARK_EMAIL_TEST_FACEBOOK_EVENTS_INTEGRATION`

Tool to test Facebook Events integration in Benchmark Email. Use when verifying the Facebook Events connection is working properly.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Facebook Integration

**Slug:** `BENCHMARK_EMAIL_TEST_FACEBOOK_INTEGRATION`

Tool to test Facebook integration status for the Benchmark Email account. Use when verifying Facebook connection. Returns status 1 on success, -1 on error, with an HTML-formatted message describing the result.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test LinkedIn Connection

**Slug:** `BENCHMARK_EMAIL_TEST_LINKED_IN_CONNECTION`

Tool to test the LinkedIn integration connection status. Use when verifying if LinkedIn is properly connected to the Benchmark Email account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Pinterest Integration

**Slug:** `BENCHMARK_EMAIL_TEST_PINTEREST_INTEGRATION`

Tool to test the Pinterest integration connection for the Benchmark Email account. Use when verifying Pinterest integration status or troubleshooting connection issues.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Salesforce Integration

**Slug:** `BENCHMARK_EMAIL_TEST_SALESFORCE_INTEGRATION`

Tool to test the Salesforce integration connection. Use when verifying that Salesforce CRM is properly connected and accessible.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Twitter Integration

**Slug:** `BENCHMARK_EMAIL_TEST_TWITTER_INTEGRATION`

Tool to test the Twitter/X integration connection. Use when verifying that Twitter (X) is properly connected and accessible.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Twitter Tweets

**Slug:** `BENCHMARK_EMAIL_TEST_TWITTER_TWEETS`

Tool to test Twitter tweets integration and retrieve follower information. Use to verify Twitter connection and get follower statistics in HTML format.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Archive Home Page

**Slug:** `BENCHMARK_EMAIL_UPDATE_ARCHIVE_HOME_PAGE`

Tool to add an email to the archive home page with a specific view order. Use when you need to feature an archived email on the archive home page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Vieworders` | string | Yes | View order for the archive email on the home page |
| `SelArchiveIDs` | string | Yes | ID of the email which want to add as archive |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Archive Home Page Data

**Slug:** `BENCHMARK_EMAIL_UPDATE_ARCHIVE_HOME_PAGE_DATA`

Tool to update archive home page data like page title, logo, header, and footer. Use when modifying the appearance or content of the archive home page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Archive home page data containing page title, logo, header, and footer information |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact Details

**Slug:** `BENCHMARK_EMAIL_UPDATE_CONTACT_DETAILS`

Tool to update contact details in a specific list. Use when you need to modify a contact's email, name, or rating.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Data` | object | Yes | Contact data to update |
| `ListID` | string | Yes | ID of the contact list |
| `ContactID` | string | Yes | ID of the contact to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Campaign

**Slug:** `BENCHMARK_EMAIL_UPDATE_EMAIL`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Unique identifier of the email campaign to update |
| `Detail` | object | Yes | Payload containing the fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Content for Automation

**Slug:** `BENCHMARK_EMAIL_UPDATE_EMAIL_CONTENT_FOR_AUTOMATION`

Tool to update email content for an automation workflow. Use when modifying the subject, template content, or sender details of an existing automation email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Content` | object | Yes | Email content object containing the fields to update |
| `automation_id` | string | Yes | ID of the automation workflow containing the email |
| `automation_detail_id` | string | Yes | ID of the automation email to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Linked Agency Account

**Slug:** `BENCHMARK_EMAIL_UPDATE_LINK_ACCOUNT`

Tool to update a linked agency account. Use when modifying login credentials or alias for an existing linked account by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ID` | string | Yes | Link Account ID to update |
| `Alias` | string | Yes | Alias name for the link account |
| `Login` | string | Yes | Login email/ID for the link account |
| `Password` | string | Yes | Password for the link account (must be valid Benchmark Email account password) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List Compilation Details

**Slug:** `BENCHMARK_EMAIL_UPDATE_LIST_COMPILATION_DETAILS`

Tool to update the compilation details for a contact list file upload. Use when changing the file upload compilation URL after uploading contacts to a list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Mode` | string | Yes | Compilation mode setting (typically '0' for standard mode) |
| `ListID` | string | Yes | ID of the contact list whose compilation details should be changed |
| `FileName` | string | Yes | Name of the compiled file on the server (e.g., 'fehokpdx.x0o.csv') |
| `OriginalFileName` | string | Yes | Original name of the uploaded file (e.g., 'test_contacts.csv') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Partner Profile

**Slug:** `BENCHMARK_EMAIL_UPDATE_PARTNER_PROFILE`

Tool to update partner profile details including company name, email, phone, and PayPal email. Use when you need to modify partner account information. PayPalEmail is required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Detail` | object | Yes | Partner profile details to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Poll

**Slug:** `BENCHMARK_EMAIL_UPDATE_POLL`

Tool to update an existing poll in Benchmark Email. Use when you need to modify a poll's name or question.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Name` | string | Yes | Updated name of the poll |
| `poll_id` | string | Yes | Unique identifier of the poll to update |
| `Question` | string | Yes | Updated poll question to be displayed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update/Reset Email

**Slug:** `BENCHMARK_EMAIL_UPDATE_RESET_EMAIL`

Tool to reset the primary email address using a GUID from the reset email link. Use when completing the email change process after the reset link has been sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `GUID` | string | Yes | The ID which is available on the email link sent for resetting the email |
| `NewEmail` | string | Yes | The new email address to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Segment

**Slug:** `BENCHMARK_EMAIL_UPDATE_SEGMENT`

Tool to update an existing contact segment. Use when you need to modify a segment's name, description, or associated list ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Data` | object | Yes | Payload containing the fields to update |
| `segment_id` | string | Yes | Unique identifier of the segment to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Survey Status

**Slug:** `BENCHMARK_EMAIL_UPDATE_SURVEY_STATUS`

Tool to update the status of a survey. Use when activating, deactivating, or removing a survey.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("inactive" | "active" | "removed") | Yes | New status for the survey: active (1), inactive (0), or removed (3) |
| `survey_id` | string | Yes | Unique identifier of the survey to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Video

**Slug:** `BENCHMARK_EMAIL_UPLOAD_VIDEO`

Tool to upload a video via URL. Use when adding videos from external sources (YouTube, Vimeo, etc.) to the Benchmark Email account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `VideoUrl` | string | Yes | URL of the video to upload (e.g., YouTube, Vimeo URL) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
