> **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 BigMailer

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

**Authentication:** API Key
**Categories:** Marketing, Communication
**Tools:** 59: 29 read, 24 write, 6 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=BIGMAILER)

## 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 BigMailer connection

   In **AgentKit > Connections**, create a BigMailer 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 = 'bigmailer'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize BigMailer:', 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: 'bigmailer_brands_list',
     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 = "bigmailer"
   identifier = "user_123"

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

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

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their BigMailer 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: 'bigmailer_brand_get',
  toolInput: {
    brand_id: '<brand_id>',
  },
  connector: 'bigmailer',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="bigmailer_brand_get",
    tool_input={
        "brand_id": "<brand_id>",
    },
    connection_name="bigmailer",
    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.

### `bigmailer_brand_get`

Get Brand · Read-only

Get one brand by ID.
Returns the brand's name, default sender, time zone, bounce settings and limits.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_brand_properties_list`

List Brand Properties · Read-only

List brand properties: reusable values (such as an address or logo HTML) inserted with merge tags.
Returns each property's ID, name, merge tag and value.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_brands_list`

List Brands · Read-only

List the brands in the BigMailer account.
Returns each brand's ID, name, sender defaults and contact counts.
Use the brand ID with every other tool.

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

Inputs:

- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

Example input: `{}`

### `bigmailer_bulk_campaign_get`

Get Bulk Campaign · Read-only

Get one bulk campaign.
Returns its content, audience, status, schedule and stats (sent, opens, clicks, bounces, unsubscribes).

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_bulk_campaign_url_clicks_list`

List Bulk Campaign Link Clicks · Read-only

List link clicks for a bulk campaign.
Returns each URL with its click counts.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `page` (`integer`, optional): Page number, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Items per page. Example: 50.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_bulk_campaigns_list`

List Bulk Campaigns · Read-only

List bulk (newsletter) campaigns, with cursor paging.
Returns each campaign's ID, name, subject, status, schedule and stats.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_connections_list`

List Connections · Read-only

List the sending connections (Amazon SES accounts) linked to BigMailer.
Returns each connection's ID, type and status.

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

Inputs:

- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

Example input: `{}`

### `bigmailer_contact_get`

Get Contact · Read-only

Get one contact by ID or email address.
Returns the contact's email, field values, lists and unsubscribe settings.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `contact_id` (`string`, required): ID or email address of the contact. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_contacts_batch_get`

Get Contact Batch Status · Read-only

Get the status of a contact batch upload.
Returns the batch status and counts of created, updated and failed contacts with errors.

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

Inputs:

- `batch_id` (`string`, required): ID of the contact batch. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"batch_id":"<batch_id>","brand_id":"<brand_id>"}`

### `bigmailer_contacts_list`

List Contacts · Read-only

List contacts in a brand, optionally only those on one list, with cursor paging.
Returns each contact's ID, email, field values, lists and unsubscribes.
Use bigmailer_contact_get for one contact.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.
- `list_id` (`string`, optional): Only contacts on this list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_fields_list`

List Fields · Read-only

List fields in a brand, with cursor paging.
Returns each field's ID, name and settings, and a cursor for the next page.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_list_get`

Get List · Read-only

Get one list by ID.
Returns the list's details.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `list_id` (`string`, required): ID of the list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_lists_list`

List Lists · Read-only

List lists in a brand, with cursor paging.
Returns each list's ID, name and settings, and a cursor for the next page.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_message_types_list`

List Message Types · Read-only

List message types, which contacts can unsubscribe from separately.
Returns each type's ID and name.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.
- `type` (`string`, optional): Only message types of this type. Example: all. One of: `all`, `account`, `user`.

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

### `bigmailer_rss_campaign_get`

Get RSS Campaign · Read-only

Get one RSS-to-email campaign.
Returns its feed, schedule, content and status.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_rss_campaign_updates_list`

List RSS Campaign Sends · Read-only

List the emails an RSS campaign has sent (one per feed update).
Returns each send's ID, subject, date and stats.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `parent_id` (`string`, required): ID of the RSS campaign. Get it from bigmailer_rss_campaigns_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

Example input: `{"brand_id":"<brand_id>","parent_id":"<parent_id>"}`

### `bigmailer_rss_campaigns_list`

List RSS Campaigns · Read-only

List RSS-to-email campaigns.
Returns each campaign's ID, name, feed URL, schedule and status.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_segment_get`

Get Segment · Read-only

Get one segment by ID.
Returns the segment's details.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `segment_id` (`string`, required): ID of the segment. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_segments_list`

List Segments · Read-only

List segments in a brand, with cursor paging.
Returns each segment's ID, name and settings, and a cursor for the next page.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_sender_get`

Get Sender · Read-only

Get one sender by ID.
Returns the sender's details.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `sender_id` (`string`, required): ID of the sender. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","sender_id":"<sender_id>"}`

### `bigmailer_senders_list`

List Senders · Read-only

List senders in a brand, with cursor paging.
Returns each sender's ID, name and settings, and a cursor for the next page.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_suppression_list_get`

Get Suppression List · Read-only

Get one campaign suppression list.
Returns its name, status and count.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `suppression_list_id` (`string`, required): ID of the suppression list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","suppression_list_id":"<suppression_list_id>"}`

### `bigmailer_suppression_lists_list`

List Suppression Lists · Read-only

List campaign suppression lists (emails never to send a campaign to).
Returns each list's ID, name and count.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_template_get`

Get Template · Read-only

Get one template by ID.
Returns the template's details.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `template_id` (`string`, required): ID of the template. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","template_id":"<template_id>"}`

### `bigmailer_templates_list`

List Templates · Read-only

List templates in a brand, with cursor paging.
Returns each template's ID, name and settings, and a cursor for the next page.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_test_campaigns_list`

List Test Campaigns · Read-only

List test emails sent from the brand.
Returns each test's ID, subject, recipients and date.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_transactional_campaign_get`

Get Transactional Campaign · Read-only

Get one transactional campaign.
Returns its content, sender, settings and stats.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_transactional_campaign_url_clicks_list`

List Transactional Link Clicks · Read-only

List link clicks for a transactional campaign.
Returns each URL with its click counts.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `page` (`integer`, optional): Page number, starting at 1. Example: 1.
- `per_page` (`integer`, optional): Items per page. Example: 50.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_transactional_campaigns_list`

List Transactional Campaigns · Read-only

List transactional email campaigns (templates sent one at a time through the API).
Returns each campaign's ID, name, subject and stats.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `cursor` (`string`, optional): Cursor from the previous response, to get the next page. Example: eyJpZCI6MTIzfQ.
- `limit` (`integer`, optional): Maximum number of items to return (up to 100). Example: 25.

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

### `bigmailer_brand_create`

Create Brand · Write

Create a brand with its default sender.
Returns the new brand's ID.

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

Inputs:

- `from_email` (`string`, required): Default email used in the "From:" header in campaigns sent from this brand. Example: news@acme.com.
- `from_name` (`string`, required): Default name used in the "From:" header in campaigns sent from this brand. Example: Acme.
- `name` (`string`, required): Name of the brand. Example: Acme.
- `bounce_danger_percent` (`integer`, optional): An integer percentage (0-100). If a bulk campaign in the brand reaches this threshold percent of bounces, it is paused automatically. Example: 3.
- `connection_id` (`string`, optional): ID of the sending connection. Get it from bigmailer_connections_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `contact_limit` (`integer`, optional): The maxmimum number of contacts the brand is allowed to contain. Example: 0.
- `max_soft_bounces` (`integer`, optional): The maximum number of times a contact can soft bounce before it is considered undeliverable. Set to 0 to remove the limit on soft bounces. Example: 5.
- `timezone` (`string`, optional): IANA time zone, such as America/New_York. Example: America/New_York.
- `unsubscribe_text` (`string`, optional): A message displayed to contacts on the brand unsubscribe page. Example: Unsubscribe.
- `url` (`string`, optional): URL of a website associated with the brand. Example: https://acme.com.

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

### `bigmailer_bulk_campaign_create`

Create Bulk Campaign · Write

Create a bulk (newsletter) campaign for lists or a segment; set ready to true to send or schedule it.
Returns the new campaign's ID.
Send a preview first with bigmailer_test_campaign_send.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, required): Name of the campaign. Example: May newsletter.
- `auto_text` (`boolean`, optional): True to generate the text body automatically from the HTML body. Example: true.
- `excluded_list_ids` (`array`, optional): IDs of lists to leave out. Example: [].
- `from` (`object`, optional): Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
- `html` (`string`, optional): HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body>Hi *|FIRST_NAME|*
</body></html>.
- `link_params` (`string`, optional): Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
- `list_ids` (`array`, optional): IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
- `message_type_id` (`string`, optional): ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `preview` (`string`, optional): Copy shown following your subject line in many email clients. Example: Our biggest update yet.
- `ready` (`boolean`, optional): true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
- `recipient_name` (`string`, optional): Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
- `reply_to` (`object`, optional): Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
- `scheduled_for` (`integer`, optional): When to send, as a Unix timestamp; leave empty to send when ready. Example: 1780000000.
- `segment_id` (`string`, optional): ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `subject` (`string`, optional): Subject line for the campaign. Example: What's new in May.
- `template_id` (`string`, optional): ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `text` (`string`, optional): Text body of the email. Example: Hi *|FIRST_NAME|*.
- `track_clicks` (`boolean`, optional): True to enable click tracking in HTML links. Example: true.
- `track_opens` (`boolean`, optional): True to enable open tracking (HTML campaigns only). Example: true.

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

### `bigmailer_bulk_campaign_update`

Update Bulk Campaign · Write

Update a draft bulk campaign, or set ready to true to send or schedule it.
Returns the campaign's ID.
Only the fields you pass change.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `auto_text` (`boolean`, optional): True to generate the text body automatically from the HTML body. Example: true.
- `excluded_list_ids` (`array`, optional): IDs of lists to leave out. Example: [].
- `from` (`object`, optional): Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
- `html` (`string`, optional): HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body>Hi *|FIRST_NAME|*
</body></html>.
- `link_params` (`string`, optional): Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
- `list_ids` (`array`, optional): IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
- `message_type_id` (`string`, optional): ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, optional): Name of the campaign. Example: May newsletter.
- `preview` (`string`, optional): Copy shown following your subject line in many email clients. Example: Our biggest update yet.
- `ready` (`boolean`, optional): true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
- `recipient_name` (`string`, optional): Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
- `reply_to` (`object`, optional): Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
- `scheduled_for` (`integer`, optional): When to send, as a Unix timestamp; leave empty to send when ready. Example: 1780000000.
- `segment_id` (`string`, optional): ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `subject` (`string`, optional): Subject line for the campaign. Example: What's new in May.
- `template_id` (`string`, optional): ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `text` (`string`, optional): Text body of the email. Example: Hi *|FIRST_NAME|*.
- `track_clicks` (`boolean`, optional): True to enable click tracking in HTML links. Example: true.
- `track_opens` (`boolean`, optional): True to enable open tracking (HTML campaigns only). Example: true.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_contact_create`

Create Contact · Write

Create a contact in a brand, with field values and list memberships.
Returns the new contact's ID.
Use bigmailer_contact_upsert to update an existing email instead of failing.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `email` (`string`, required): Email address of the contact. Example: jane@example.com.
- `field_values` (`array`, optional): Custom field values: each has the field name (merge tag) and a string, integer or date value. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
- `list_ids` (`array`, optional): IDs of the lists the contact is on. Get them from bigmailer_lists_list. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
- `unsubscribe_all` (`boolean`, optional): true to unsubscribe the contact from all email. Example: false.
- `unsubscribe_ids` (`array`, optional): IDs of message types the contact is unsubscribed from. Example: [].
- `validate` (`string`, optional): true to validate the email address before saving. Example: true. One of: `true`, `false`.

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

### `bigmailer_contact_update`

Update Contact · Write

Update a contact's email, field values, lists or unsubscribes, replacing, adding to or removing from each list field.
Returns the contact's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `contact_id` (`string`, required): ID or email address of the contact. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `email` (`string`, optional): Email address of the contact. Example: jane@example.com.
- `field_values` (`array`, optional): Custom field values: each has the field name (merge tag) and a string, integer or date value. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
- `field_values_op` (`string`, optional): How to apply field_values: replace, add or remove. Example: add. One of: `add`, `remove`, `replace`.
- `list_ids` (`array`, optional): IDs of the lists the contact is on. Get them from bigmailer_lists_list. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
- `list_ids_op` (`string`, optional): How to apply list_ids: replace, add or remove. Example: add. One of: `add`, `remove`, `replace`.
- `unsubscribe_all` (`boolean`, optional): true to unsubscribe the contact from all email. Example: false.
- `unsubscribe_ids` (`array`, optional): IDs of message types the contact is unsubscribed from. Example: [].
- `unsubscribe_ids_op` (`string`, optional): How to apply unsubscribe_ids: replace, add or remove. Example: add. One of: `add`, `remove`, `replace`.

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

### `bigmailer_contact_upsert`

Create or Update Contact · Write

Create a contact, or update it if the email already exists in the brand.
Returns the contact's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `email` (`string`, required): Email address of the contact. Example: jane@example.com.
- `field_values` (`array`, optional): Custom field values: each has the field name (merge tag) and a string, integer or date value. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
- `list_ids` (`array`, optional): IDs of the lists the contact is on. Get them from bigmailer_lists_list. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
- `unsubscribe_all` (`boolean`, optional): true to unsubscribe the contact from all email. Example: false.
- `unsubscribe_ids` (`array`, optional): IDs of message types the contact is unsubscribed from. Example: [].
- `validate` (`string`, optional): true to validate the email address before saving. Example: true. One of: `true`, `false`.

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

### `bigmailer_contacts_batch_upload`

Upload Contact Batch · Write

Create or update many contacts in one asynchronous batch.
Returns the batch ID; check it with bigmailer_contacts_batch_get.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `items` (`array`, required): Contacts to create or update, each like the contact create body (email, field_values, list_ids, unsubscribe_all, unsubscribe_ids). Example: [{"email": "jane@example.com", "list_ids": ["<list id>"]}].
- `validate` (`boolean`, optional): true to validate the email addresses. Example: true.

Example input: `{"brand_id":"<brand_id>","items":[]}`

### `bigmailer_field_create`

Create Field · Write

Create a field in a brand.
Returns the new field's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, required): Name of the field. Example: First name.
- `type` (`string`, required): Type of the field. Example: text. One of: `date`, `integer`, `text`.
- `merge_tag_name` (`string`, optional): Merge tag used in emails as *|TAG|*, such as FIRST_NAME. Example: FIRST_NAME.
- `sample_value` (`string`, optional): A value used for the field when sending test campaigns. Example: Jane.

Example input: `{"brand_id":"<brand_id>","name":"<name>","type":"date"}`

### `bigmailer_list_create`

Create List · Write

Create a list in a brand.
Returns the new list's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, required): Name of the list. Example: Newsletter.

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

### `bigmailer_list_update`

Update List · Write

Update a list.
Returns the list's ID.
Only the fields you pass change.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `list_id` (`string`, required): ID of the list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, optional): Name of the list. Example: Newsletter 2026.

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

### `bigmailer_rss_campaign_create`

Create RSS Campaign · Write

Create an RSS-to-email campaign that emails new feed items on a schedule.
Returns the new campaign's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, required): Name of the campaign. Example: May newsletter.
- `auto_text` (`boolean`, optional): True to generate the text body automatically from the HTML body. Example: true.
- `excluded_list_ids` (`array`, optional): IDs of lists to leave out. Example: [].
- `feed_url` (`string`, optional): URL of the RSS feed. Example: https://example.com/feed.xml.
- `from` (`object`, optional): Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
- `html` (`string`, optional): HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body>Hi *|FIRST_NAME|*
</body></html>.
- `link_params` (`string`, optional): Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
- `list_ids` (`array`, optional): IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
- `message_type_id` (`string`, optional): ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `preview` (`string`, optional): Copy shown following your subject line in many email clients. Example: Our biggest update yet.
- `ready` (`boolean`, optional): true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
- `recipient_name` (`string`, optional): Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
- `reply_to` (`object`, optional): Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
- `segment_id` (`string`, optional): ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `subject` (`string`, optional): Subject line for the campaign. Example: What's new in May.
- `template_id` (`string`, optional): ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `text` (`string`, optional): Text body of the email. Example: Hi *|FIRST_NAME|*.
- `track_clicks` (`boolean`, optional): True to enable click tracking in HTML links. Example: true.
- `track_opens` (`boolean`, optional): True to enable open tracking (HTML campaigns only). Example: true.

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

### `bigmailer_rss_campaign_pause`

Pause RSS Campaign · Write

Pause an RSS-to-email campaign.
Returns the campaign's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_rss_campaign_unpause`

Resume RSS Campaign · Write

Resume a paused RSS-to-email campaign.
Returns the campaign's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_rss_campaign_update`

Update RSS Campaign · Write

Update an RSS-to-email campaign.
Returns the campaign's ID.
Only the fields you pass change.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `auto_text` (`boolean`, optional): True to generate the text body automatically from the HTML body. Example: true.
- `excluded_list_ids` (`array`, optional): IDs of lists to leave out. Example: [].
- `feed_url` (`string`, optional): URL of the RSS feed. Example: https://example.com/feed.xml.
- `from` (`object`, optional): Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
- `html` (`string`, optional): HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body>Hi *|FIRST_NAME|*
</body></html>.
- `link_params` (`string`, optional): Additional query string parameters to add to all links in the template. Example: utm_source=bigmailer.
- `list_ids` (`array`, optional): IDs of the lists to send to. Example: ["6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34"].
- `message_type_id` (`string`, optional): ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, optional): Name of the campaign. Example: May newsletter.
- `preview` (`string`, optional): Copy shown following your subject line in many email clients. Example: Our biggest update yet.
- `ready` (`boolean`, optional): true to send (or schedule) the campaign; false keeps it as a draft. Example: false.
- `recipient_name` (`string`, optional): Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
- `reply_to` (`object`, optional): Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
- `segment_id` (`string`, optional): ID of a segment to narrow the audience. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `subject` (`string`, optional): Subject line for the campaign. Example: What's new in May.
- `template_id` (`string`, optional): ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `text` (`string`, optional): Text body of the email. Example: Hi *|FIRST_NAME|*.
- `track_clicks` (`boolean`, optional): True to enable click tracking in HTML links. Example: true.
- `track_opens` (`boolean`, optional): True to enable open tracking (HTML campaigns only). Example: true.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_segment_create`

Create Segment · Write

Create a segment in a brand.
Returns the new segment's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `conditions` (`array`, required): Conditions, each with a type: field (id of a field, operator such as is or contains, and text_value, email_value, integer_value or date_value), date_added, campaign_activity (operator such as opened or clicked, optional campaign id and days), subscription, reference (another segment) or location. Example: [{"type": "campaign_activity", "operator": "opened", "days": 30}].
- `name` (`string`, required): Name of the segment. Example: Engaged.
- `operator` (`string`, required): all to match every condition, any to match at least one. Example: all. One of: `all`, `any`.

Example input: `{"brand_id":"<brand_id>","conditions":[{"type":"campaign_activity","operator":"opened","days":30}],"name":"<name>","operator":"all"}`

### `bigmailer_segment_update`

Update Segment · Write

Update a segment.
Returns the segment's ID.
Only the fields you pass change.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `segment_id` (`string`, required): ID of the segment. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `conditions` (`array`, optional): An array of conditions that the segment must satisfy. See our [description of segment conditions](https://docs.bigmailer.io/docs/segments). Example: [{"type": "campaign_activity", "operator": "opened", "days": 30}].
- `name` (`string`, optional): Name of the segment. Example: Engaged.
- `operator` (`string`, optional): all to match every condition, any to match at least one. Example: all. One of: `all`, `any`.

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

### `bigmailer_sender_create`

Create Sender · Write

Create a sender in a brand.
Returns the new sender's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `identity` (`string`, required): Email address or domain to send from. Example: news@acme.com.
- `identity_type` (`string`, optional): email or domain. Example: email. One of: `domain`, `email`.
- `share_type` (`string`, optional): Set to all to share the sender with all brands. Set to none to use only within the current brand. Example: all. One of: `all`, `none`.

Example input: `{"brand_id":"<brand_id>","identity":"<identity>"}`

### `bigmailer_sender_verify`

Verify Sender · Write

Start or re-check verification of a sender email or domain.
Returns the sender's verification status.
An email sender gets a verification email; a domain needs its DNS records.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `sender_id` (`string`, required): ID of the sender. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","sender_id":"<sender_id>"}`

### `bigmailer_template_create`

Create Template · Write

Create a template in a brand.
Returns the new template's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `html` (`string`, required): HTML body of the template. Example: <html><body>*|CONTENT|*</body></html>.
- `name` (`string`, required): Name of the template. Example: Newsletter layout.
- `type` (`string`, required): Type of campaigns the template may be used with. Example: email. One of: `email`, `page`.
- `shared_with_account` (`boolean`, optional): true if the template is shared with all brands in the account. false otherwise. Example: false.

Example input: `{"brand_id":"<brand_id>","html":"<html>","name":"<name>","type":"email"}`

### `bigmailer_template_update`

Update Template · Write

Update a template.
Returns the template's ID.
Only the fields you pass change.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `template_id` (`string`, required): ID of the template. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `html` (`string`, optional): HTML body of the template. Example: <html><body>*|CONTENT|*</body></html>.
- `name` (`string`, optional): Name of the template. Example: Newsletter layout v2.
- `shared_with_account` (`boolean`, optional): true if the template is shared with all brands in the account. false otherwise. Example: false.
- `type` (`string`, optional): Type of campaigns the template may be used with. Example: email. One of: `email`, `page`.

Example input: `{"brand_id":"<brand_id>","template_id":"<template_id>"}`

### `bigmailer_test_campaign_send`

Send Test Campaign · Write

Send a test email with campaign content to a few addresses.
Returns the test campaign's ID.
Use it to preview content before sending a bulk campaign.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `recipients` (`array`, required): Email addresses to send the test to. Example: ["jane@example.com"].
- `auto_text` (`boolean`, optional): True to generate the text body automatically from the HTML body. Example: true.
- `feed_url` (`string`, optional): RSS feed URL, to test RSS content. Example: https://example.com/feed.xml.
- `from` (`object`, optional): Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
- `html` (`string`, optional): HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body>Hi *|FIRST_NAME|*
</body></html>.
- `preview` (`string`, optional): Copy shown following your subject line in many email clients. Example: Our biggest update yet.
- `recipient_name` (`string`, optional): Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
- `reply_to` (`object`, optional): Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
- `subject` (`string`, optional): Subject line for the campaign. Example: What's new in May.
- `text` (`string`, optional): Text body of the email. Example: Hi *|FIRST_NAME|*.
- `track_clicks` (`boolean`, optional): True to enable click tracking in HTML links. Example: true.
- `track_opens` (`boolean`, optional): True to enable open tracking (HTML campaigns only). Example: true.

Example input: `{"brand_id":"<brand_id>","recipients":["jane@example.com"]}`

### `bigmailer_transactional_campaign_create`

Create Transactional Campaign · Write

Create a transactional email campaign to send to single contacts through the API.
Returns the new campaign's ID.
Send it with bigmailer_transactional_email_send.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, required): Name of the campaign. Example: May newsletter.
- `auto_text` (`boolean`, optional): True to generate the text body automatically from the HTML body. Example: true.
- `from` (`object`, optional): Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
- `html` (`string`, optional): HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body>Hi *|FIRST_NAME|*
</body></html>.
- `list_id` (`string`, optional): List to add recipients to. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `message_type_id` (`string`, optional): ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `preview` (`string`, optional): Copy shown following your subject line in many email clients. Example: Our biggest update yet.
- `ready` (`boolean`, optional): true to make the campaign ready to send. Example: true.
- `recipient_name` (`string`, optional): Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
- `reply_to` (`object`, optional): Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
- `subject` (`string`, optional): Subject line for the campaign. Example: What's new in May.
- `template_id` (`string`, optional): ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `text` (`string`, optional): Text body of the email. Example: Hi *|FIRST_NAME|*.
- `track_clicks` (`boolean`, optional): True to enable click tracking in HTML links. Example: true.
- `track_opens` (`boolean`, optional): True to enable open tracking (HTML campaigns only). Example: true.

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

### `bigmailer_transactional_campaign_update`

Update Transactional Campaign · Write

Update a transactional campaign's content, sender or settings.
Returns the campaign's ID.
Only the fields you pass change.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `auto_text` (`boolean`, optional): True to generate the text body automatically from the HTML body. Example: true.
- `from` (`object`, optional): Sender as an object with email and name; the email must be a verified sender. Example: {"email": "news@acme.com", "name": "Acme"}.
- `html` (`string`, optional): HTML body; use merge tags like *|FIRST_NAME|*. Example: <html><body>Hi *|FIRST_NAME|*
</body></html>.
- `list_id` (`string`, optional): List to add recipients to. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `message_type_id` (`string`, optional): ID of the message type, for subscription preferences. Get it from bigmailer_message_types_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `name` (`string`, optional): Name of the campaign. Example: May newsletter.
- `preview` (`string`, optional): Copy shown following your subject line in many email clients. Example: Our biggest update yet.
- `ready` (`boolean`, optional): true to make the campaign ready to send. Example: true.
- `recipient_name` (`string`, optional): Name of the recipient. Use merge tags to make it more personal and avoid spam filters. Example: *|FIRST_NAME|*.
- `reply_to` (`object`, optional): Reply-to as an object with email and name. Example: {"email": "support@acme.com", "name": "Acme Support"}.
- `subject` (`string`, optional): Subject line for the campaign. Example: What's new in May.
- `template_id` (`string`, optional): ID of a template to use instead of html. Get it from bigmailer_templates_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `text` (`string`, optional): Text body of the email. Example: Hi *|FIRST_NAME|*.
- `track_clicks` (`boolean`, optional): True to enable click tracking in HTML links. Example: true.
- `track_opens` (`boolean`, optional): True to enable open tracking (HTML campaigns only). Example: true.

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>"}`

### `bigmailer_transactional_email_send`

Send Transactional Email · Write

Send a transactional campaign's email to one address, with field values and template variables.
Returns the send's ID.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `campaign_id` (`string`, required): ID of the campaign. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `email` (`string`, required): Recipient email address. Example: jane@example.com.
- `field_values` (`array`, optional): Contact field values to save and merge. Example: [{"name": "FIRST_NAME", "string": "Jane"}].
- `variables` (`array`, optional): One-off template variables for this email. Example: [{"name": "ORDER_ID", "value": "A-1001"}].

Example input: `{"brand_id":"<brand_id>","campaign_id":"<campaign_id>","email":"<email>"}`

### `bigmailer_contact_delete`

Delete Contact · Destructive

Delete a contact from a brand.
Returns an empty response on success.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `contact_id` (`string`, required): ID or email address of the contact. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_field_delete`

Delete Field · Destructive

Delete a field.
Returns an empty response on success.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `field_id` (`string`, required): ID of the field. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","field_id":"<field_id>"}`

### `bigmailer_list_delete`

Delete List · Destructive

Delete a list.
Returns an empty response on success.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `list_id` (`string`, required): ID of the list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_segment_delete`

Delete Segment · Destructive

Delete a segment.
Returns an empty response on success.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `segment_id` (`string`, required): ID of the segment. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

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

### `bigmailer_sender_delete`

Delete Sender · Destructive

Delete a sender.
Returns an empty response on success.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `sender_id` (`string`, required): ID of the sender. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","sender_id":"<sender_id>"}`

### `bigmailer_template_delete`

Delete Template · Destructive

Delete a template.
Returns an empty response on success.

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

Inputs:

- `brand_id` (`string`, required): ID of the brand. Get it from bigmailer_brands_list. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.
- `template_id` (`string`, required): ID of the template. Example: 6f1c2a9e-3b4d-4e8a-9c21-7d5e0b1a2f34.

Example input: `{"brand_id":"<brand_id>","template_id":"<template_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 |
