> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Benchmark Email

The Benchmark Email connector lets your AI agent act in each user's Benchmark Email account. Each user connects their own Benchmark Email API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 57 tools.

**Authentication:** API Key
**Categories:** Marketing, Communication
**Tools:** 57: 36 read, 14 write, 7 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=BENCHMARKEMAIL)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Benchmark Email connection

   In **AgentKit > Connections**, create a Benchmark Email connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'benchmarkemail'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Benchmark Email:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'benchmarkemail_account_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "benchmarkemail"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Benchmark Email:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="benchmarkemail_account_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Benchmark Email credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'benchmarkemail_account_get',
  toolInput: {},
  connector: 'benchmarkemail',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="benchmarkemail_account_get",
    tool_input={},
    connection_name="benchmarkemail",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `benchmarkemail_account_get`

Get Account Details · Read-only

Get the Benchmark Email account profile.
Returns the account's name, company, login email, address, plan and settings in Response.Data.
Use it to confirm the connection works and see who the API token belongs to.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `benchmarkemail_automation_get`

Get Automation · Read-only

Get one automation by ID.
Returns the automation's name, type, sender, target list, status and its emails in Response.Data.
Use benchmarkemail_automations_list to find the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `automation_id` (`string`, required): ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.

Example input: `{"automation_id":"<automation_id>"}`

### `benchmarkemail_automation_report_get`

Get Automation Report · Read-only

Get the summary report for an automation.
Returns sends, opens, clicks, bounces and unsubscribes for each email in the automation in Response.Data.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `automation_id` (`string`, required): ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.

Example input: `{"automation_id":"<automation_id>"}`

### `benchmarkemail_automations_list`

List Automations · Read-only

List automations (autoresponder series), with paging, sorting and a name filter.
Returns each automation's ID, name, status, list and email count in Response.Data.
Use benchmarkemail_automation_get for one automation's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `benchmarkemail_confirmed_emails_list`

List Confirmed Sender Emails · Read-only

List the sender email addresses confirmed in the account.
Returns the confirmed From addresses in Response.Emails.
Use it before benchmarkemail_email_create to pick a valid from_email.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `benchmarkemail_contact_get`

Get Contact · Read-only

Get one contact in a contact list by contact ID.
Returns the contact's email, names, field values, opt-in data and status in Response.Data.
Use benchmarkemail_contacts_search or benchmarkemail_list_contacts_list to find the contact ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"contact_id":"<contact_id>","list_id":"<list_id>"}`

### `benchmarkemail_contact_history_get`

Get Contact Email History · Read-only

Get the campaign history for one email address.
Returns the campaigns sent to the address and its opens, clicks and bounces in Response.Data.
Use it to see one subscriber's engagement.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, required): Email address of the contact. Example: jane@example.com.
- `order_by` (`string`, optional): Field to sort by. Example: date.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.

Example input: `{"email":"<email>"}`

### `benchmarkemail_contact_import_status_get`

Get Contact Import Status · Read-only

Get the status of recent contact imports.
Returns each import's type, list IDs, contacts found and contacts added in Response.Data.
Use it after benchmarkemail_contacts_bulk_add to check progress.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `benchmarkemail_contacts_search`

Search Contacts · Read-only

Search all contact lists for a contact by email address.
Returns matching contacts with their list IDs, contact IDs and status in Response.Data.
Use it to find which lists an email is on. Use benchmarkemail_list_contacts_list to browse one list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `search` (`string`, required): Email address (or part of one) to search for. Example: jane@example.com.
- `search_filter` (`string`, optional): Optional extra filter value. Example: 1.

Example input: `{"search":"<search>"}`

### `benchmarkemail_email_get`

Get Email · Read-only

Get one email campaign by ID.
Returns the campaign's name, subject, sender, content, target lists, status and schedule in Response.Data.
Use benchmarkemail_emails_list to find the ID. Use benchmarkemail_email_report_get for its results.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_recipient_count_get`

Get Email Recipient Count · Read-only

Count how many contacts an email campaign will be sent to.
Returns Response.Count.
Use it before benchmarkemail_email_schedule to check the audience size.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_bounces_list`

List Email Bounces · Read-only

List the contacts who bounced for a sent email campaign, with paging.
Returns each contact's email and the event details in Response.Data, with Response.Count.
Use benchmarkemail_email_report_get for the totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_click_performance_get`

Get Email Click Performance · Read-only

Get link click performance for a sent email campaign.
Returns each link URL with its total and unique clicks in Response.Data.
Use benchmarkemail_email_report_clicks_list for who clicked.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_clicks_list`

List Email Clicks · Read-only

List the contacts who clicked a link for a sent email campaign, with paging.
Returns each contact's email and the event details in Response.Data, with Response.Count.
Use benchmarkemail_email_report_get for the totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_forwards_list`

List Email Forwards · Read-only

List the contacts who forwarded the email for a sent email campaign, with paging.
Returns each contact's email and the event details in Response.Data, with Response.Count.
Use benchmarkemail_email_report_get for the totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_get`

Get Email Report · Read-only

Get the summary report for one sent email campaign.
Returns sends, opens, clicks, bounces, unsubscribes, forwards and abuse reports, with rates, in Response.Data.
Use the benchmarkemail_email_report_* list tools for the contacts behind each number.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_opens_list`

List Email Opens · Read-only

List the contacts who opened for a sent email campaign, with paging.
Returns each contact's email and the event details in Response.Data, with Response.Count.
Use benchmarkemail_email_report_get for the totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
- `filter` (`string`, optional): Text to match against email addresses. Example: example.com.
- `order_by` (`string`, optional): Field to sort by, such as email. Example: email.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_unopens_list`

List Email Non-Openers · Read-only

List the contacts who did not open for a sent email campaign, with paging.
Returns each contact's email and the event details in Response.Data, with Response.Count.
Use benchmarkemail_email_report_get for the totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_report_unsubscribes_list`

List Email Unsubscribes · Read-only

List the contacts who unsubscribed for a sent email campaign, with paging.
Returns each contact's email and the event details in Response.Data, with Response.Count.
Use benchmarkemail_email_report_get for the totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_email_reports_list`

List Email Reports · Read-only

List sent email campaigns with their headline results.
Returns each sent campaign's ID, name, send date, sends, opens, clicks, bounces and unsubscribes in Response.Data.
Use it to compare campaigns. Use benchmarkemail_email_report_get for one campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `ab_filter` (`string`, optional): A/B test filter. Example: 0.
- `filter` (`string`, optional): Text to match against campaign names. Example: Newsletter.
- `filter_type` (`string`, optional): Filter type. Example: 1.
- `order_by` (`string`, optional): Field to sort by. Example: date.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `benchmarkemail_email_spam_check`

Check Email Spam Score · Read-only

Run a spam check on an email campaign's content.
Returns the spam score and the rules it triggered in Response.Data.
Use it before sending to catch content likely to be filtered.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_emails_list`

List Emails · Read-only

List email campaigns, with paging, sorting, a name filter and a status filter.
Returns each campaign's ID, name, subject, status and schedule date in Response.Data.
Use it to find a campaign ID. Use benchmarkemail_email_get for one campaign's full details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `exclude_email_id` (`string`, optional): Campaign ID to leave out of the results. Example: 8754320.
- `filter` (`string`, optional): Text to match against campaign names. Example: Newsletter.
- `filter_type` (`string`, optional): Filter type. Example: 1.
- `order_by` (`string`, optional): Field to sort by: email, date, count or schedule. Example: date. One of: `email`, `date`, `count`, `schedule`.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): Campaign status filter. Example: 1.

Example input: `{}`

### `benchmarkemail_list_contact_summary_get`

Get Contact List Summary · Read-only

Get a contact list's subscriber summary.
Returns counts of active, unsubscribed, bounced and other contacts in the list.
Use it for list health. Use benchmarkemail_list_contacts_list for the contacts themselves.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"list_id":"<list_id>"}`

### `benchmarkemail_list_contacts_list`

List Contacts in List · Read-only

List the contacts in one contact list, with search, status filter, paging and sorting.
Returns each contact's ID, email, names, fields and status in Response.Data, with Response.Count.
Use it to browse a list. Use benchmarkemail_contacts_search to find an email across all lists.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
- `filter` (`string`, optional): Contact status filter: 2 unsubscribed, 5 hard bounced, 100 all other contacts (not unsubscribed or hard bounced). Example: 100. One of: `2`, `5`, `100`.
- `order_by` (`string`, optional): Field to sort by: email, firstname, lastname or date. Example: email. One of: `email`, `firstname`, `lastname`, `date`.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `search_field` (`string`, optional): Field to search, such as email, name, address, date1 or date2. Example: email.
- `search_filter` (`string`, optional): Value to search for in the field chosen by search_field. Example: jane.
- `search_type` (`string`, optional): How search_filter matches: 1 starts with, 2 exact, 3 contains, 4 ends with. Example: 3. One of: `1`, `2`, `3`, `4`.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.

Example input: `{"list_id":"<list_id>"}`

### `benchmarkemail_list_fields_get`

Get Contact List Fields · Read-only

Get the field labels and types defined on a contact list.
Returns the list's field names (Field1 to Field24) and their types in Response.Data.
Use it to learn which field1..field24 keys to set in benchmarkemail_contact_add.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"list_id":"<list_id>"}`

### `benchmarkemail_list_get`

Get Contact List · Read-only

Get one contact list by ID.
Returns the list name, description, field labels, contact counts and created date in Response.Data.
Use benchmarkemail_lists_list to find the ID. Use benchmarkemail_list_fields_get for field names only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"list_id":"<list_id>"}`

### `benchmarkemail_list_webhooks_list`

List List Webhooks · Read-only

List the webhooks set on a contact list.
Returns each webhook's ID, URL and which events it reports in Response.Data.
Use it before updating or deleting a webhook.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"list_id":"<list_id>"}`

### `benchmarkemail_lists_list`

List Contact Lists · Read-only

List contact lists in the account, with paging, sorting and a name filter.
Returns each list's ID, name, contact count and dates in Response.Data, with Response.Count.
Use it to find a list ID. Use benchmarkemail_list_get for one list's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_by` (`string`, optional): Field to sort by: email, date, count or schedule. Example: date. One of: `email`, `date`, `count`, `schedule`.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `search_filter` (`string`, optional): Text to match against list names. Example: Newsletter.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): Status filter. Example: 1.

Example input: `{}`

### `benchmarkemail_segment_contacts_list`

List Segment Contacts · Read-only

List the contacts that match a segment, with search, paging and sorting.
Returns each matching contact's email, names and fields in Response.Data, with Response.Count.
Use benchmarkemail_list_contacts_list for a whole list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `segment_id` (`string`, required): ID of the segment. Get it from benchmarkemail_segments_list. Example: 123456.
- `order_by` (`string`, optional): Field to sort by: email or date. Example: email. One of: `email`, `date`.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `search_field` (`string`, optional): Field to search: Email or Name. Example: Email.
- `search_filter` (`string`, optional): Value to search for. Example: jane.
- `search_type` (`string`, optional): How search_filter matches: 1 starts with, 2 exact, 3 contains, 4 ends with. Example: 3. One of: `1`, `2`, `3`, `4`.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.

Example input: `{"segment_id":"<segment_id>"}`

### `benchmarkemail_segment_get`

Get Segment · Read-only

Get one segment by ID.
Returns the segment's name, description, list and criteria in Response.Data.
Use benchmarkemail_segments_list to find the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `segment_id` (`string`, required): ID of the segment. Get it from benchmarkemail_segments_list. Example: 123456.

Example input: `{"segment_id":"<segment_id>"}`

### `benchmarkemail_segments_list`

List Segments · Read-only

List contact segments, with paging, sorting and a name filter.
Returns each segment's ID, name, list and contact count in Response.Data.
Use benchmarkemail_segment_contacts_list for the contacts in a segment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): Text to match against segment names. Example: VIP.
- `order_by` (`string`, optional): Field to sort by: name or date. Example: date. One of: `name`, `date`.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.

Example input: `{}`

### `benchmarkemail_signup_form_get`

Get Signup Form · Read-only

Get one signup form by ID.
Returns the form's name, linked lists, fields and settings in Response.Data.
Use benchmarkemail_signup_forms_list to find the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `signup_form_id` (`string`, required): ID of the signup form. Get it from benchmarkemail_signup_forms_list. Example: 556677.

Example input: `{"signup_form_id":"<signup_form_id>"}`

### `benchmarkemail_signup_forms_list`

List Signup Forms · Read-only

List the signup forms in the account, with paging, sorting and a filter.
Returns each form's ID, name, linked lists and dates in Response.Data.
Use benchmarkemail_signup_form_get for one form.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `benchmarkemail_survey_get`

Get Survey · Read-only

Get one survey by ID.
Returns the survey's name, status, settings and questions in Response.Data.
Use benchmarkemail_surveys_list to find the ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `survey_id` (`string`, required): ID of the survey. Get it from benchmarkemail_surveys_list. Example: 334455.

Example input: `{"survey_id":"<survey_id>"}`

### `benchmarkemail_surveys_list`

List Surveys · Read-only

List surveys in the account, with paging, sorting and a name filter.
Returns each survey's ID, name, status and response count in Response.Data.
Use benchmarkemail_survey_get for one survey.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `benchmarkemail_templates_list`

List Email Templates · Read-only

List the email templates available to the account, with paging and a name filter.
Returns each template's ID, name and category in Response.Data.
Use it to pick a design for a new campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `order_by` (`string`, optional): Field to sort by. Example: date.
- `page_number` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of records per page. Example: 25.
- `search_filter` (`string`, optional): Text to match against template names. Example: newsletter.
- `sort_order` (`string`, optional): Sort direction: asc or desc. Example: desc. One of: `asc`, `desc`.
- `status` (`string`, optional): Status filter. Example: 1.

Example input: `{}`

### `benchmarkemail_contact_add`

Add Contact to List · Write

Add one contact to a contact list.
Returns the new contact in Response.Data.
Use benchmarkemail_contact_update to change an existing contact. Use benchmarkemail_contacts_bulk_add to add many email addresses at once.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email address of the contact. Example: jane@example.com.
- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
- `email_perm` (`string`, optional): 1 if the contact gave permission to receive email, 0 if not. Example: 1. One of: `1`, `0`.
- `email_type` (`string`, optional): Preferred email format: html or text. Example: html. One of: `html`, `text`.
- `field1` (`string`, optional): Field 1 value (Address by default; see benchmarkemail_list_fields_get for this list's labels). Example: 1 Main St.
- `field10` (`string`, optional): Field 10 value (Job title by default). Example: Marketing Manager.
- `field2` (`string`, optional): Field 2 value (City by default). Example: Austin.
- `field3` (`string`, optional): Field 3 value (State by default). Example: TX.
- `field4` (`string`, optional): Field 4 value (Zip by default). Example: 78701.
- `field5` (`string`, optional): Field 5 value (Country by default). Example: US.
- `field6` (`string`, optional): Field 6 value (Phone by default). Example: +1 512 555 0100.
- `field7` (`string`, optional): Field 7 value (Fax by default). Example: +1 512 555 0101.
- `field8` (`string`, optional): Field 8 value (Cell phone by default). Example: +1 512 555 0102.
- `field9` (`string`, optional): Field 9 value (Company name by default). Example: Acme Inc.
- `first_name` (`string`, optional): First Name of the contact. Example: Jane.
- `last_name` (`string`, optional): Last Name of the contact. Example: Doe.
- `middle_name` (`string`, optional): Middle Name of the contact. Example: Q.

Example input: `{"email":"<email>","list_id":"<list_id>"}`

### `benchmarkemail_contact_update`

Update Contact · Write

Update a contact's email, names or field values in a contact list.
Returns the updated contact in Response.Data.
Only the fields you pass change. Use benchmarkemail_contact_add for a new contact.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `contact_id` (`string`, required): ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
- `email` (`string`, optional): Email address of the contact. Example: jane@example.com.
- `email_perm` (`string`, optional): 1 if the contact gave permission to receive email, 0 if not. Example: 1. One of: `1`, `0`.
- `email_type` (`string`, optional): Preferred email format: html or text. Example: html. One of: `html`, `text`.
- `field1` (`string`, optional): Field 1 value (Address by default). Example: 1 Main St.
- `field10` (`string`, optional): Field 10 value (Job title by default). Example: Marketing Manager.
- `field2` (`string`, optional): Field 2 value (City by default). Example: Austin.
- `field3` (`string`, optional): Field 3 value (State by default). Example: TX.
- `field4` (`string`, optional): Field 4 value (Zip by default). Example: 78701.
- `field5` (`string`, optional): Field 5 value (Country by default). Example: US.
- `field6` (`string`, optional): Field 6 value (Phone by default). Example: +1 512 555 0100.
- `field7` (`string`, optional): Field 7 value (Fax by default). Example: +1 512 555 0101.
- `field8` (`string`, optional): Field 8 value (Cell phone by default). Example: +1 512 555 0102.
- `field9` (`string`, optional): Field 9 value (Company name by default). Example: Acme Inc.
- `first_name` (`string`, optional): First Name of the contact. Example: Jane.
- `last_name` (`string`, optional): Last Name of the contact. Example: Doe.
- `middle_name` (`string`, optional): Middle Name of the contact. Example: Q.

Example input: `{"contact_id":"<contact_id>","list_id":"<list_id>"}`

### `benchmarkemail_contacts_bulk_add`

Add Email Addresses to List · Write

Add several email addresses to a contact list in one call.
Returns Response.Count found and Response.TotalAdded.
Use it to add many addresses without names. Use benchmarkemail_contact_add for one contact with fields.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email_i_ds` (`string`, required): Email addresses to add, separated by commas or new lines. Example: jane@example.com,john@example.com.
- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"email_i_ds":"<email_i_ds>","list_id":"<list_id>"}`

### `benchmarkemail_contacts_copy`

Copy Contacts · Write

Copy contacts into one or more other contact lists.
Returns Response.Status.
Use benchmarkemail_contacts_move to remove them from the source list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `contact_i_ds` (`string`, required): Contact IDs to copy, separated by commas. Example: 2380718261,2380718262.
- `target_list_i_ds` (`string`, required): ID of the destination list; separate several IDs with commas. Example: 15981790.

Example input: `{"contact_i_ds":"<contact_i_ds>","target_list_i_ds":"<target_list_i_ds>"}`

### `benchmarkemail_contacts_move`

Move Contacts · Write

Move contacts from one contact list to one or more other lists.
Returns Response.Status.
Use benchmarkemail_contacts_copy to keep them in the source list too.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `contact_i_ds` (`string`, required): Contact IDs to move, separated by commas. Example: 2380718261,2380718262.
- `list_id` (`string`, required): ID of the source contact list the contacts are in now. Example: 15981783.
- `target_list_i_ds` (`string`, required): ID of the destination list; separate several IDs with commas. Example: 15981790.

Example input: `{"contact_i_ds":"<contact_i_ds>","list_id":"<list_id>","target_list_i_ds":"<target_list_i_ds>"}`

### `benchmarkemail_email_copy`

Copy Email · Write

Make a copy of an email campaign under a new name.
Returns the new campaign in Response.Data, including its ID.
Use it to reuse a past campaign's content.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
- `name` (`string`, required): Name for the copy. Example: Copy of May Newsletter.

Example input: `{"email_id":"<email_id>","name":"<name>"}`

### `benchmarkemail_email_create`

Create Email · Write

Create a draft email campaign with its subject, sender, HTML content and target lists.
Returns the new campaign in Response.Data, including its ID.
Use benchmarkemail_email_schedule to send it. Use benchmarkemail_email_test_send to preview it first.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from_email` (`string`, required): Sender email; must be a confirmed address from benchmarkemail_confirmed_emails_list. Example: news@acme.com.
- `from_name` (`string`, required): Sender name. Example: Acme Marketing.
- `name` (`string`, required): Internal name of the campaign. Example: May Newsletter.
- `subject` (`string`, required): Subject line. Example: Our May update.
- `contact_lists` (`array`, optional): Lists or segments to send to: an array of objects with ID, Name, IsSegment ("1" for a segment, "0" for a list) and SegmentID. Example: [{"ID":"15981783","IsSegment":"0","Name":"Newsletter","SegmentID":""}].
- `exclude_contact_lists` (`array`, optional): Lists or segments to leave out, in the same shape as contact_lists. Example: [{"ID":"15981790","IsSegment":"0","Name":"Unengaged","SegmentID":""}].
- `google_analytics_campaign` (`string`, optional): Google Analytics campaign name to tag links with. Example: may-newsletter.
- `has_webpage_version` (`string`, optional): 1 to include a link to a web page version, 0 to leave it out. Example: 1. One of: `1`, `0`.
- `inbox_preview_text` (`string`, optional): Preview text shown in the inbox. Example: What's new this month.
- `is_manual_text` (`string`, optional): 1 to use template_text as written, 0 to generate the text version from the HTML. Example: 0. One of: `1`, `0`.
- `reply_email` (`string`, optional): Reply-to email address. Example: support@acme.com.
- `template_content` (`string`, optional): HTML body of the email. Example: <html><body><h1>Hello</h1></body></html>.
- `template_text` (`string`, optional): Plain-text body of the email. Example: Hello.
- `version` (`string`, optional): Editor version of the email: 1 for the classic editor, 2 for the drag-and-drop editor. Example: 1. One of: `1`, `2`.

Example input: `{"from_email":"<from_email>","from_name":"<from_name>","name":"<name>","subject":"<subject>"}`

### `benchmarkemail_email_schedule`

Schedule Email · Write

Schedule a draft email campaign to send at a date and time, or resend a sent one.
Returns Response.Status.
The campaign needs a subject, sender, content and target lists first. Run benchmarkemail_email_test_send before scheduling.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
- `schedule_date` (`string`, required): Date and time to send, for example 05/20/2026 09:00 AM. Use the account's date format. Example: 05/20/2026 09:00 AM.
- `time_zone` (`string`, required): Time zone of schedule_date, for example America/New_York or EST. Example: America/New_York.
- `list_id` (`string`, optional): Only for a resend: list ID of the contacts to target. Example: 15981783.
- `send_type` (`string`, optional): Only for a resend: 2 to send to the same list again, 3 to send to a fixed set of other contacts (segment). Example: 2. One of: `2`, `3`.

Example input: `{"email_id":"<email_id>","schedule_date":"<schedule_date>","time_zone":"<time_zone>"}`

### `benchmarkemail_email_test_send`

Send Test Email · Write

Send a test copy of an email campaign to up to a few addresses.
Returns Response.Status.
Use it to preview a campaign before benchmarkemail_email_schedule.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
- `emails` (`string`, required): Email addresses to send the test to, separated by commas. Example: jane@example.com,john@example.com.
- `message` (`string`, required): Short note included with the test email. Example: Please review this draft.

Example input: `{"email_id":"<email_id>","emails":"<emails>","message":"<message>"}`

### `benchmarkemail_email_update`

Update Email · Write

Update a draft email campaign's subject, sender, content or target lists.
Returns the updated campaign in Response.Data.
Only the fields you pass change.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.
- `contact_lists` (`array`, optional): Lists or segments to send to: an array of objects with ID, Name, IsSegment ("1" for a segment, "0" for a list) and SegmentID. Example: [{"ID":"15981783","IsSegment":"0","Name":"Newsletter","SegmentID":""}].
- `exclude_contact_lists` (`array`, optional): Lists or segments to leave out, in the same shape as contact_lists. Example: [{"ID":"15981790","IsSegment":"0","Name":"Unengaged","SegmentID":""}].
- `from_email` (`string`, optional): Sender email; must be a confirmed address from benchmarkemail_confirmed_emails_list. Example: news@acme.com.
- `from_name` (`string`, optional): Sender name. Example: Acme Marketing.
- `google_analytics_campaign` (`string`, optional): Google Analytics campaign name to tag links with. Example: may-newsletter.
- `has_webpage_version` (`string`, optional): 1 to include a link to a web page version, 0 to leave it out. Example: 1. One of: `1`, `0`.
- `inbox_preview_text` (`string`, optional): Preview text shown in the inbox. Example: What's new this month.
- `is_manual_text` (`string`, optional): 1 to use template_text as written, 0 to generate the text version from the HTML. Example: 0. One of: `1`, `0`.
- `name` (`string`, optional): Internal name of the campaign. Example: May Newsletter.
- `reply_email` (`string`, optional): Reply-to email address. Example: support@acme.com.
- `subject` (`string`, optional): Subject line. Example: Our May update.
- `template_content` (`string`, optional): HTML body of the email. Example: <html><body><h1>Hello</h1></body></html>.
- `template_text` (`string`, optional): Plain-text body of the email. Example: Hello.
- `version` (`string`, optional): Editor version of the email: 1 for the classic editor, 2 for the drag-and-drop editor. Example: 1. One of: `1`, `2`.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_list_create`

Create Contact List · Write

Create a contact list.
Returns the new list in Response.Data, including its ID.
Use benchmarkemail_contact_add to add contacts to it afterwards.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the new list. Example: Spring Newsletter.
- `description` (`string`, optional): Description of the list. Example: Subscribers from the spring campaign.
- `firstname_label` (`string`, optional): Label shown for the First Name field. Example: First Name.
- `lastname_label` (`string`, optional): Label shown for the Last Name field. Example: Last Name.
- `middlename_label` (`string`, optional): Label shown for the Middle Name field. Example: Middle Name.

Example input: `{"name":"<name>"}`

### `benchmarkemail_list_update`

Update Contact List · Write

Rename a contact list or change its description and name-field labels.
Returns Response.Status and the updated list.
Only the fields you pass change.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
- `description` (`string`, optional): New list description. Example: Updated description.
- `firstname_label` (`string`, optional): New label for the First Name field. Example: First Name.
- `lastname_label` (`string`, optional): New label for the Last Name field. Example: Last Name.
- `name` (`string`, optional): New list name. Example: Spring Newsletter 2026.

Example input: `{"list_id":"<list_id>"}`

### `benchmarkemail_list_webhook_create`

Create List Webhook · Write

Create a webhook that notifies a URL about subscriber events on a contact list.
Returns the new webhook in Response.Data.
Set each event flag to 1 to be notified of it or 0 to skip it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `client_url` (`string`, required): HTTPS URL Benchmark posts the events to. Example: https://example.com/hooks/benchmark.
- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
- `cleaned_address` (`string`, optional): 1 to be notified when an address is cleaned (bounced) from the list, 0 to skip. Example: 0. One of: `1`, `0`.
- `contact_master_id` (`string`, optional): ID of the contact list; pass the same value as list_id. Example: 15981783.
- `email_changed` (`string`, optional): 1 to be notified when a contact's email changes, 0 to skip. Example: 0. One of: `1`, `0`.
- `id` (`string`, optional): ID. Example: 8754321.
- `profile_updates` (`string`, optional): 1 to be notified when a contact's profile fields change, 0 to skip. Example: 0. One of: `1`, `0`.
- `subscribes` (`string`, optional): 1 to be notified of new subscribers, 0 to skip. Example: 1. One of: `1`, `0`.
- `unsubscribes` (`string`, optional): 1 to be notified of unsubscribes, 0 to skip. Example: 1. One of: `1`, `0`.

Example input: `{"client_url":"<client_url>","list_id":"<list_id>"}`

### `benchmarkemail_list_webhook_update`

Update List Webhook · Write

Change a contact-list webhook's URL or the events it reports.
Returns Response.Status.
Use benchmarkemail_list_webhooks_list to find the webhook ID.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
- `webhook_id` (`string`, required): ID of the webhook. Get it from benchmarkemail_list_webhooks_list. Example: 998877.
- `cleaned_address` (`string`, optional): 1 to be notified when an address is cleaned (bounced) from the list, 0 to skip. Example: 0. One of: `1`, `0`.
- `client_url` (`string`, optional): HTTPS URL Benchmark posts the events to. Example: https://example.com/hooks/benchmark.
- `contact_master_id` (`string`, optional): ID of the contact list; pass the same value as list_id. Example: 15981783.
- `email_changed` (`string`, optional): 1 to be notified when a contact's email changes, 0 to skip. Example: 0. One of: `1`, `0`.
- `profile_updates` (`string`, optional): 1 to be notified when a contact's profile fields change, 0 to skip. Example: 0. One of: `1`, `0`.
- `subscribes` (`string`, optional): 1 to be notified of new subscribers, 0 to skip. Example: 1. One of: `1`, `0`.
- `unsubscribes` (`string`, optional): 1 to be notified of unsubscribes, 0 to skip. Example: 1. One of: `1`, `0`.

Example input: `{"list_id":"<list_id>","webhook_id":"<webhook_id>"}`

### `benchmarkemail_automation_delete`

Delete Automation · Destructive

Delete an automation and stop its emails.
Returns Response.Status.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `automation_id` (`string`, required): ID of the automation. Get it from benchmarkemail_automations_list. Example: 45678.

Example input: `{"automation_id":"<automation_id>"}`

### `benchmarkemail_contact_delete`

Delete Contact from List · Destructive

Delete a contact from one contact list.
Returns Response.Status.
Use benchmarkemail_contact_unsubscribe to keep the contact but stop all email to it.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"contact_id":"<contact_id>","list_id":"<list_id>"}`

### `benchmarkemail_contact_unsubscribe`

Unsubscribe Contact · Destructive

Move a contact to the account's Do Not Contact (master unsubscribe) list.
Returns Response.Status.
Use it to stop all email to an address. Use benchmarkemail_contact_delete to only remove it from one list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): ID of the contact. Get it from benchmarkemail_list_contacts_list or benchmarkemail_contacts_search. Example: 2380718261.
- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"contact_id":"<contact_id>","list_id":"<list_id>"}`

### `benchmarkemail_email_delete`

Delete Email · Destructive

Delete an email campaign and move it to the trash.
Returns Response.Status.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `email_id` (`string`, required): ID of the email campaign. Get it from benchmarkemail_emails_list. Example: 8754321.

Example input: `{"email_id":"<email_id>"}`

### `benchmarkemail_list_delete`

Delete Contact List · Destructive

Delete a contact list and move it to the trash.
Returns Response.Status.
Use benchmarkemail_contact_delete to remove a single contact instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.

Example input: `{"list_id":"<list_id>"}`

### `benchmarkemail_list_webhook_delete`

Delete List Webhook · Destructive

Delete a webhook from a contact list.
Returns Response.Status.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): ID of the contact list. Get it from benchmarkemail_lists_list. Example: 15981783.
- `webhook_id` (`string`, required): ID of the webhook. Get it from benchmarkemail_list_webhooks_list. Example: 998877.

Example input: `{"list_id":"<list_id>","webhook_id":"<webhook_id>"}`

### `benchmarkemail_segment_delete`

Delete Segment · Destructive

Delete a segment. The contacts stay in their list.
Returns Response.Status.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `segment_id` (`string`, required): ID of the segment. Get it from benchmarkemail_segments_list. Example: 123456.

Example input: `{"segment_id":"<segment_id>"}`

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
