> **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 Elastic Email

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

**Authentication:** API Key
**Categories:** Marketing, Communication
**Tools:** 60: 30 read, 21 write, 9 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=ELASTICEMAIL)

## 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 Elastic Email connection

   In **AgentKit > Connections**, create an Elastic 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 = 'elasticemail'
   const identifier = 'user_123'

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

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

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

   ```bash
   python quickstart.py
   ```

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

**Python**

```python
result = actions.execute_tool(
    tool_name="elasticemail_account_get",
    tool_input={},
    connection_name="elasticemail",
    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.

### `elasticemail_account_get`

Get Account · Read-only

Get public information about the Elastic Email account that owns the API key.
Returns the account's Identity, Profile, Branding, Usage, Billing, Sending and Features sections.
Use elasticemail_account_get to confirm which account the key belongs to.

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

Inputs: none.

Example input: `{}`

### `elasticemail_campaign_get`

Get Campaign · Read-only

Get one campaign by name.
Returns Name, Status, Content, Recipients, ExcludedRecipients and Options.
Use elasticemail_campaign_get for a known campaign. Use elasticemail_campaign_stats_get for its results.

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

Inputs:

- `name` (`string`, required): Name of the campaign. Example: Fall sale 2026.

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

### `elasticemail_campaign_stats_get`

Get Campaign Stats · Read-only

Get sending statistics for one campaign.
Returns its delivery, open, click, bounce, complaint and unsubscribe counts.
Use elasticemail_campaign_stats_get for a known campaign's results.

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

Inputs:

- `name` (`string`, required): Name of the campaign. Example: Fall sale 2026.

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

### `elasticemail_campaign_stats_list`

List Campaign Stats · Read-only

List sending statistics for every campaign.
Returns one summary per campaign with its ChannelName and delivery, open, click, bounce and unsubscribe counts.
Use elasticemail_campaign_stats_list to compare campaigns. Use elasticemail_campaign_stats_get for one campaign.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

Example input: `{}`

### `elasticemail_campaigns_list`

List Campaigns · Read-only

List the account's campaigns, optionally filtered by a fragment of the name (up to 1,000).
Returns campaigns with Name, Status, Content, Recipients and Options.
Use elasticemail_campaigns_list to browse or find campaigns. Use elasticemail_campaign_get for one campaign by name.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `search` (`string`, optional): Return campaigns whose name contains this text. Example: fall.

Example input: `{}`

### `elasticemail_channel_events_list`

List Channel Events · Read-only

List delivery events for one channel, filtered by type and date (up to 1,000 per call).
Returns events with TransactionID, MsgID, To, EventType, EventDate and Message.
Use elasticemail_channel_events_list for one channel. Use elasticemail_events_list for the whole account.

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

Inputs:

- `name` (`string`, required): Name of the channel. Example: order-notifications.
- `event_types` (`array`, optional): Only return events of these types. Example: ["Bounce", "Complaint"].
- `from` (`string`, optional): Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
- `limit` (`integer`, optional): Maximum number of items to return. Up to 1000. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `order_by` (`string`, optional): Sort order by event date. Defaults to DateDescending. Example: DateAscending. One of: `DateDescending`, `DateAscending`.
- `to` (`string`, optional): End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.

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

### `elasticemail_channel_stats_get`

Get Channel Stats · Read-only

Get sending statistics for one channel (the channel_name given on sends).
Returns its delivery, open, click, bounce, complaint and unsubscribe counts.
Use elasticemail_channel_stats_get for a known channel.

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

Inputs:

- `name` (`string`, required): Name of the channel. Example: order-notifications.

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

### `elasticemail_channel_stats_list`

List Channel Stats · Read-only

List sending statistics for every channel.
Returns one summary per channel with delivery, open, click, bounce and unsubscribe counts.
Use elasticemail_channel_stats_list to compare channels. Use elasticemail_channel_stats_get for one channel.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

Example input: `{}`

### `elasticemail_contact_get`

Get Contact · Read-only

Get one contact by email address.
Returns Email, Status, FirstName, LastName, CustomFields, Consent, Source and Activity.
Use elasticemail_contact_get for a known address. Use elasticemail_contacts_list to browse.

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

Inputs:

- `email` (`string`, required): The contact's email address. Example: john.doe@example.com.

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

### `elasticemail_contacts_export_status_get`

Get Contacts Export Status · Read-only

Get the status of a contacts export.
Returns the status: Loading, Ready, Error or Expired. Download from the Link that elasticemail_contacts_export returned once it is Ready.
Use elasticemail_contacts_export_status_get to poll an export started with elasticemail_contacts_export.

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

Inputs:

- `export_id` (`string`, required): ID of the export, returned by elasticemail_contacts_export. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.

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

### `elasticemail_contacts_list`

List Contacts · Read-only

List the account's contacts, one page at a time.
Returns contacts with Email, Status, FirstName, LastName, CustomFields, Consent, Source and Activity.
Use elasticemail_contacts_list to browse all contacts. Use elasticemail_list_contacts_list for one list, or elasticemail_contact_get for one address.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Defaults to 20. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

Example input: `{}`

### `elasticemail_email_events_list`

List Email Events · Read-only

List the delivery events of one send by its transaction ID.
Returns events with MsgID, To, EventType, EventDate and Message.
Use elasticemail_email_events_list to follow one send. Use elasticemail_email_status_get for its summary.
Requires the TransactionID returned by a send tool.

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

Inputs:

- `transaction_id` (`string`, required): Transaction ID returned by a send tool. Example: 5c2d4a3f-9e1b-4b8a-a0a3-2f7f5e9c1d22.
- `from` (`string`, optional): Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `order_by` (`string`, optional): Sort order by event date. Defaults to DateDescending. Example: DateAscending. One of: `DateDescending`, `DateAscending`.
- `to` (`string`, optional): End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.

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

### `elasticemail_email_status_get`

Get Email Status · Read-only

Get the delivery status of a send by its transaction ID, with optional lists of addresses in each state.
Returns ID, Status, RecipientsCount and counts for failed, sent, delivered, pending, opened, clicked, unsubscribed and abuse reports, plus the address lists and MessageIDs you ask for.
Use elasticemail_email_status_get for a send's summary. Use elasticemail_email_events_list for its event log.
Requires the TransactionID returned by a send tool.

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

Inputs:

- `transaction_id` (`string`, required): Transaction ID returned by a send tool. Example: 5c2d4a3f-9e1b-4b8a-a0a3-2f7f5e9c1d22.
- `show_abuse` (`boolean`, optional): Set true to include the addresses that reported abuse. Defaults to false. Example: true.
- `show_clicked` (`boolean`, optional): Set true to include the addresses that clicked. Defaults to false. Example: true.
- `show_delivered` (`boolean`, optional): Set true to include the delivered addresses. Defaults to false. Example: true.
- `show_errors` (`boolean`, optional): Set true to include the error messages for bounced emails. Defaults to false. Example: true.
- `show_failed` (`boolean`, optional): Set true to include the bounced addresses. Defaults to false. Example: true.
- `show_message_ids` (`boolean`, optional): Set true to include the message IDs. Defaults to false. Example: true.
- `show_opened` (`boolean`, optional): Set true to include the addresses that opened. Defaults to false. Example: true.
- `show_pending` (`boolean`, optional): Set true to include the addresses waiting to send. Defaults to false. Example: true.
- `show_sent` (`boolean`, optional): Set true to include the sent addresses. Defaults to false. Example: true.
- `show_unsubscribed` (`boolean`, optional): Set true to include the unsubscribed addresses. Defaults to false. Example: true.

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

### `elasticemail_email_view`

View Email · Read-only

Get the content of one sent email by its message ID, for viewing or rendering.
Returns Preview (subject, from and body), Attachments and Status (sender, recipient, dates sent, opened and clicked, and any error).
Use elasticemail_email_view to see what a recipient received.
Requires a MessageID from a send tool or from events.

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

Inputs:

- `message_id` (`string`, required): Message ID of the email, from a send response or an event. Example: hR8kL2mN4pQ6rS8tU0vW2x.

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

### `elasticemail_events_list`

List Events · Read-only

List delivery events across the account, such as sends, opens, clicks, bounces and complaints, filtered by type and date (up to 1,000 per call).
Returns events with TransactionID, MsgID, FromEmail, To, Subject, EventType, EventDate, ChannelName and Message.
Use elasticemail_events_list for account-wide activity. Use elasticemail_email_events_list for one send, or elasticemail_channel_events_list for one channel.

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

Inputs:

- `event_types` (`array`, optional): Only return events of these types. Example: ["Bounce", "Complaint"].
- `from` (`string`, optional): Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
- `limit` (`integer`, optional): Maximum number of items to return. Up to 1000. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `order_by` (`string`, optional): Sort order by event date. Defaults to DateDescending. Example: DateAscending. One of: `DateDescending`, `DateAscending`.
- `to` (`string`, optional): End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.

Example input: `{}`

### `elasticemail_list_contacts_list`

List Contacts in List · Read-only

List the contacts on one list.
Returns contacts with Email, Status, FirstName, LastName and CustomFields.
Use elasticemail_list_contacts_list for one list's members. Use elasticemail_contacts_list for all contacts.

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

Inputs:

- `name` (`string`, required): Name of the list. Example: Newsletter.
- `limit` (`integer`, optional): Maximum number of items to return. Defaults to 20. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

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

### `elasticemail_list_get`

Get List · Read-only

Get one contact list by name.
Returns ListName, PublicListID, DateAdded and AllowUnsubscribe.
Use elasticemail_list_get for a known list.

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

Inputs:

- `name` (`string`, required): Name of the list. Example: Newsletter.

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

### `elasticemail_lists_list`

List Lists · Read-only

List the account's contact lists.
Returns lists with ListName, PublicListID, DateAdded and AllowUnsubscribe.
Use elasticemail_lists_list to find list names. Use elasticemail_list_contacts_list for the contacts on a list.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

Example input: `{}`

### `elasticemail_segment_get`

Get Segment · Read-only

Get one segment by name. The name All Contacts returns every contact.
Returns Name and Rule.
Use elasticemail_segment_get for a known segment.

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

Inputs:

- `name` (`string`, required): Name of the segment. Example: Engaged last 30 days.

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

### `elasticemail_segments_list`

List Segments · Read-only

List the account's segments.
Returns segments with Name and Rule.
Use elasticemail_segments_list to find segment names for campaigns.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

Example input: `{}`

### `elasticemail_statistics_get`

Get Statistics · Read-only

Get the account's sending statistics for a time range.
Returns Recipients, EmailTotal, SmsTotal, Delivered, Bounced, InProgress, Opened, Clicked, Unsubscribed, Complaints, Inbound, ManualCancel and NotDelivered.
Use elasticemail_statistics_get for account-wide totals. Use elasticemail_campaign_stats_get or elasticemail_channel_stats_get for one campaign or channel.

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

Inputs:

- `from` (`string`, required): Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
- `to` (`string`, optional): End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.

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

### `elasticemail_suppression_bounces_list`

List Bounces · Read-only

List the account's bounces suppressions, optionally searched by text.
Returns suppressions, each with Email, FriendlyErrorMessage, ErrorCode and DateUpdated.
Use elasticemail_suppression_bounces_list for bounces only. Use elasticemail_suppressions_list for every type.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `search` (`string`, optional): Text fragment to search for. Example: example.com.

Example input: `{}`

### `elasticemail_suppression_complaints_list`

List Complaints · Read-only

List the account's complaints suppressions, optionally searched by text.
Returns suppressions, each with Email, FriendlyErrorMessage, ErrorCode and DateUpdated.
Use elasticemail_suppression_complaints_list for complaints only. Use elasticemail_suppressions_list for every type.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `search` (`string`, optional): Text fragment to search for. Example: example.com.

Example input: `{}`

### `elasticemail_suppression_get`

Get Suppression · Read-only

Check whether one address is suppressed, and why.
Returns Email, FriendlyErrorMessage, ErrorCode and DateUpdated.
Use elasticemail_suppression_get to check an address before sending.

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

Inputs:

- `email` (`string`, required): The email address to check. Example: john.doe@example.com.

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

### `elasticemail_suppression_unsubscribes_list`

List Unsubscribes · Read-only

List the account's unsubscribes suppressions, optionally searched by text.
Returns suppressions, each with Email, FriendlyErrorMessage, ErrorCode and DateUpdated.
Use elasticemail_suppression_unsubscribes_list for unsubscribes only. Use elasticemail_suppressions_list for every type.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `search` (`string`, optional): Text fragment to search for. Example: example.com.

Example input: `{}`

### `elasticemail_suppressions_list`

List Suppressions · Read-only

List every suppressed address on the account: bounces, complaints and unsubscribes.
Returns suppressions with Email, FriendlyErrorMessage, ErrorCode and DateUpdated.
Use elasticemail_suppressions_list for all types. Use the bounces, complaints or unsubscribes list tools for one type, or elasticemail_suppression_get for one address.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

Example input: `{}`

### `elasticemail_template_get`

Get Template · Read-only

Get one email template by name.
Returns Name, Subject, Body parts, TemplateScope, TemplateType and DateAdded.
Use elasticemail_template_get to read a template's content.

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

Inputs:

- `name` (`string`, required): Name of the template. Example: order-shipped.

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

### `elasticemail_templates_list`

List Templates · Read-only

List email templates by scope and, optionally, type.
Returns templates with Name, Subject, Body, TemplateScope, TemplateType and DateAdded.
Use elasticemail_templates_list to find template names for sending. Use elasticemail_template_get for one template's content.

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

Inputs:

- `scope_type` (`array`, required): Template scopes to return: Personal, Global, or both. Example: ["Personal"].
- `limit` (`integer`, optional): Maximum number of items to return. Defaults to 500. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.
- `template_types` (`array`, optional): Only return templates of these types. Example: ["RawHTML", "DragDropEditor"].

Example input: `{"scope_type":["Personal"]}`

### `elasticemail_verification_get`

Get Verification Result · Read-only

Get the stored result of an earlier single-email verification.
Returns the same fields as elasticemail_email_verify.
Use elasticemail_verification_get to reuse a past result without spending a credit.

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

Inputs:

- `email` (`string`, required): The verified email address. Example: john.doe@example.com.

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

### `elasticemail_verifications_list`

List Verification Results · Read-only

List the stored results of single-email verifications.
Returns results with Email, Result, Reason, Role, Disposable and DateAdded.
Use elasticemail_verifications_list to review past checks.

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

Inputs:

- `limit` (`integer`, optional): Maximum number of items to return. Example: 50.
- `offset` (`integer`, optional): Number of items to skip, for paging. Example: 50.

Example input: `{}`

### `elasticemail_automation_trigger`

Trigger Automation · Write

Start an automation for one contact by hand.
Returns no content on success.
Use elasticemail_automation_trigger to put a contact into an automation flow, for example after an event in another system.

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

Inputs:

- `contact_email` (`string`, required): Email address of the contact to start the automation for. Example: john.doe@example.com.
- `name` (`string`, required): Name of the automation. Example: Welcome series.

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

### `elasticemail_campaign_create`

Create Campaign · Write

Create a campaign that sends to saved lists or segments. With status Active it sends (or schedules) right away; with Draft it is only saved.
Returns the created campaign.
Use elasticemail_campaign_create for marketing sends to lists or segments. Use elasticemail_email_send for sends to given addresses.

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

Inputs:

- `campaign_name` (`string`, required): Unique name for the campaign. Example: Fall sale 2026.
- `content` (`array`, optional): The campaign's email content. Each item needs a From address and usually a TemplateName and Subject; ReplyTo, AttachFiles, Utm and Poolname are optional. Several items make an A/X split test. Example: [{"From": "John Doe <john@yourdomain.com>", "Subject": "Fall sale", "TemplateName": "fall-sale"}].
- `excluded_list_names` (`array`, optional): Names of lists whose contacts are left out. Example: ["Do not email"].
- `excluded_segment_names` (`array`, optional): Names of segments whose contacts are left out. Example: ["Bounced"].
- `list_names` (`array`, optional): Names of contact lists to send to. Provide list_names, segment_names, or both. Example: ["Newsletter"].
- `options` (`object`, optional): Send options: DeliveryOptimization (None, ToEngagedFirst or ByOpenTime), TrackOpens, TrackClicks, ScheduleFor (a date-time), TriggerFrequency and TriggerCount for repeats, SplitOptions for split tests, and SendAtLocalTime. Example: {"TrackOpens": true, "ScheduleFor": "2026-12-01T09:00:00"}.
- `segment_names` (`array`, optional): Names of segments to send to. Example: ["Engaged last 30 days"].
- `status` (`string`, optional): Campaign status. Draft saves it without sending; Active starts it (or schedules it when options set ScheduleFor). Example: Draft. One of: `Draft`, `Active`, `Paused`, `Cancelled`, `Deleted`, `Processing`, `Sending`, `Completed`.

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

### `elasticemail_campaign_pause`

Pause Campaign · Write

Pause a campaign and cancel the emails still waiting to be sent.
Returns no content on success.
Use elasticemail_campaign_pause to stop a running campaign. Use elasticemail_campaign_delete to remove it.

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

Inputs:

- `name` (`string`, required): Name of the campaign. Example: Fall sale 2026.

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

### `elasticemail_campaign_update`

Update Campaign · Write

Replace a campaign's settings. Only Active and Paused campaigns can be updated, and fields you leave out are cleared.
Returns the updated campaign.
Use elasticemail_campaign_update to change recipients, content or options. Read the campaign with elasticemail_campaign_get first and send back every field you want to keep.

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

Inputs:

- `campaign_name` (`string`, required): Name to give the campaign, which can rename it. Use the current name to keep it. Example: Fall sale 2026.
- `name` (`string`, required): Name of the campaign to update. Example: Fall sale 2026.
- `content` (`array`, optional): The campaign's email content. Each item needs a From address and usually a TemplateName and Subject; ReplyTo, AttachFiles, Utm and Poolname are optional. Several items make an A/X split test. Example: [{"From": "John Doe <john@yourdomain.com>", "Subject": "Fall sale", "TemplateName": "fall-sale"}].
- `excluded_list_names` (`array`, optional): Names of lists whose contacts are left out. Example: ["Do not email"].
- `excluded_segment_names` (`array`, optional): Names of segments whose contacts are left out. Example: ["Bounced"].
- `list_names` (`array`, optional): Names of contact lists to send to. Provide list_names, segment_names, or both. Example: ["Newsletter"].
- `options` (`object`, optional): Send options: DeliveryOptimization (None, ToEngagedFirst or ByOpenTime), TrackOpens, TrackClicks, ScheduleFor (a date-time), TriggerFrequency and TriggerCount for repeats, SplitOptions for split tests, and SendAtLocalTime. Example: {"TrackOpens": true, "ScheduleFor": "2026-12-01T09:00:00"}.
- `segment_names` (`array`, optional): Names of segments to send to. Example: ["Engaged last 30 days"].
- `status` (`string`, optional): Campaign status. Draft saves it without sending; Active starts it (or schedules it when options set ScheduleFor). Example: Draft. One of: `Draft`, `Active`, `Paused`, `Cancelled`, `Deleted`, `Processing`, `Sending`, `Completed`.

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

### `elasticemail_contact_update`

Update Contact · Write

Update a contact's name or custom fields. Fields you leave out are not changed.
Returns the updated contact.
Use elasticemail_contact_update to edit one contact. Use elasticemail_contacts_add to create contacts.

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

Inputs:

- `email` (`string`, required): The contact's email address. Example: john.doe@example.com.
- `custom_fields` (`object`, optional): Custom field values to set, as field-name to value pairs. Example: {"city": "Austin"}.
- `first_name` (`string`, optional): New first name. Example: John.
- `last_name` (`string`, optional): New last name. Example: Doe.

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

### `elasticemail_contacts_add`

Add Contacts · Write

Add up to 1,000 new contacts, optionally to one or more lists.
Returns the created contacts.
Use elasticemail_contacts_add to create contacts. Use elasticemail_contact_update to change one, or elasticemail_list_contacts_add to put existing contacts on a list.

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

Inputs:

- `contacts` (`array`, required): Contacts to add, up to 1,000. Each needs an Email; FirstName, LastName, Status, CustomFields (only fields that already exist in the account) and Consent are optional. Example: [{"Email": "john.doe@example.com", "FirstName": "John", "LastName": "Doe"}].
- `list_names` (`array`, optional): Names of lists to add the new contacts to. Example: ["Newsletter"].

Example input: `{"contacts":[{"Email":"john.doe@example.com","FirstName":"John","LastName":"Doe"}]}`

### `elasticemail_contacts_export`

Export Contacts · Write

Start an export of contacts to a downloadable file, all of them or those matching a rule or list of emails.
Returns PublicExportID and Link, the file's download address once the export is ready.
Use elasticemail_contacts_export to get contacts as a file. Poll elasticemail_contacts_export_status_get with the returned ID.

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

Inputs:

- `compression_format` (`string`, optional): None or Zip. Example: Zip. One of: `None`, `Zip`.
- `emails` (`array`, optional): Email addresses of the contacts to export. Example: ["john.doe@example.com"].
- `file_format` (`string`, optional): File format. Defaults to Csv. Example: Csv. One of: `Csv`, `Xml`, `Json`.
- `file_name` (`string`, optional): File name, including the extension. Example: contacts.csv.
- `rule` (`string`, optional): SQL-like rule selecting the contacts to export. Example: Status = 'Engaged'.

Example input: `{}`

### `elasticemail_email_mergefile_send`

Send Email to CSV · Write

Send a personalized email to every row of a CSV file whose first column is the email address and whose header row names the merge fields.
Returns TransactionID and MessageID. Track delivery with elasticemail_email_status_get or elasticemail_email_events_list.
Use elasticemail_email_mergefile_send when the recipients and their merge data come as a CSV. Use elasticemail_email_send to pass recipients as JSON.

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

Inputs:

- `from` (`string`, required): Sender address, optionally with a name, on a domain verified in Elastic Email. Example: John Doe <john@yourdomain.com>.
- `merge_file_content` (`string`, required): The CSV file as a Base64 string. The first column must be the email address and the first row must be a header row; other columns become merge fields. Example: ZW1haWwsZmlyc3RuYW1lCmpvaG4uZG9lQGV4YW1wbGUuY29tLEpvaG4K.
- `merge_file_name` (`string`, required): File name for the CSV. Example: recipients.csv.
- `attach_files` (`array`, optional): Names of files already uploaded to Elastic Email to attach. Example: ["terms.pdf"].
- `attachments` (`array`, optional): Files to attach, each with a Name and its BinaryContent as a Base64 string, plus an optional ContentType. Example: [{"Name": "invoice.txt", "BinaryContent": "SGVsbG8=", "ContentType": "text/plain"}].
- `body_html` (`string`, optional): HTML body. Can use merge fields such as {firstname}. Provide body_html, body_text, or template_name. Example: Hi {firstname}, your order has shipped.
.
- `body_text` (`string`, optional): Plain-text body. Can use merge fields. Example: Hi {firstname}, your order has shipped.
- `channel_name` (`string`, optional): Channel name used to group this send in statistics and events. Example: order-notifications.
- `encoding` (`string`, optional): Content transfer encoding. Example: QuotedPrintable. One of: `UserProvided`, `None`, `Raw7bit`, `Raw8bit`, `QuotedPrintable`, `Base64`, `Uue`.
- `envelope_from` (`string`, optional): Envelope-from address, optionally with a name. Example: Bounces <bounces@yourdomain.com>.
- `headers` (`object`, optional): Custom email headers, as header-name to value pairs. Example: {"X-Campaign": "fall-sale"}.
- `idempotency_key` (`string`, optional): Key that makes a retry safe: a repeated request with the same key and body returns the stored result instead of sending again. Example: order-12345-shipped.
- `merge` (`object`, optional): Merge fields shared by all recipients, as name to value pairs; use them in the content as {name}. Example: {"company": "Acme"}.
- `pool_name` (`string`, optional): Name of your custom IP pool to send from. Example: marketing-pool.
- `postback` (`string`, optional): Value for the postback header, returned with this message's events and webhooks. Example: order-12345.
- `reply_to` (`string`, optional): Reply-to address, optionally with a name. Example: Support <support@yourdomain.com>.
- `subject` (`string`, optional): Subject line. Can use merge fields such as {firstname}. Required unless the template sets one. Example: Your order has shipped.
- `template_name` (`string`, optional): Name of a saved Elastic Email template to use as the content instead of body_html or body_text. Example: order-shipped.
- `time_offset` (`integer`, optional): Delay sending by this many minutes, up to 35 days. Example: 60.
- `track_clicks` (`boolean`, optional): Track link clicks. When omitted, the account's default applies. Example: true.
- `track_opens` (`boolean`, optional): Track opens. When omitted, the account's default applies. Example: true.
- `utm` (`object`, optional): UTM parameters to add to links, with Source, Medium, Campaign and Content keys. Example: {"Source": "newsletter", "Medium": "email", "Campaign": "fall-sale"}.

Example input: `{"from":"<from>","merge_file_content":"<merge_file_content>","merge_file_name":"<merge_file_name>"}`

### `elasticemail_email_send`

Send Bulk Email · Write

Send an email to one or more recipients, each receiving their own copy with personal merge fields.
Returns TransactionID and MessageID. Track delivery with elasticemail_email_status_get or elasticemail_email_events_list.
Use elasticemail_email_send for personalized or bulk sends where recipients must not see each other. Use elasticemail_email_transactional_send for one message with visible To and CC recipients. Use elasticemail_campaign_create to send to saved lists or segments.

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

Inputs:

- `from` (`string`, required): Sender address, optionally with a name, on a domain verified in Elastic Email. Example: John Doe <john@yourdomain.com>.
- `recipients` (`array`, required): Recipients, each with an Email and optional Fields of personal merge values used in the content as {name}. Example: [{"Email": "john.doe@example.com", "Fields": {"firstname": "John"}}].
- `attach_files` (`array`, optional): Names of files already uploaded to Elastic Email to attach. Example: ["terms.pdf"].
- `attachments` (`array`, optional): Files to attach, each with a Name and its BinaryContent as a Base64 string, plus an optional ContentType. Example: [{"Name": "invoice.txt", "BinaryContent": "SGVsbG8=", "ContentType": "text/plain"}].
- `body_html` (`string`, optional): HTML body. Can use merge fields such as {firstname}. Provide body_html, body_text, or template_name. Example: Hi {firstname}, your order has shipped.
.
- `body_text` (`string`, optional): Plain-text body. Can use merge fields. Example: Hi {firstname}, your order has shipped.
- `channel_name` (`string`, optional): Channel name used to group this send in statistics and events. Example: order-notifications.
- `encoding` (`string`, optional): Content transfer encoding. Example: QuotedPrintable. One of: `UserProvided`, `None`, `Raw7bit`, `Raw8bit`, `QuotedPrintable`, `Base64`, `Uue`.
- `envelope_from` (`string`, optional): Envelope-from address, optionally with a name. Example: Bounces <bounces@yourdomain.com>.
- `headers` (`object`, optional): Custom email headers, as header-name to value pairs. Example: {"X-Campaign": "fall-sale"}.
- `idempotency_key` (`string`, optional): Key that makes a retry safe: a repeated request with the same key and body returns the stored result instead of sending again. Example: order-12345-shipped.
- `merge` (`object`, optional): Merge fields shared by all recipients, as name to value pairs; use them in the content as {name}. Example: {"company": "Acme"}.
- `pool_name` (`string`, optional): Name of your custom IP pool to send from. Example: marketing-pool.
- `postback` (`string`, optional): Value for the postback header, returned with this message's events and webhooks. Example: order-12345.
- `reply_to` (`string`, optional): Reply-to address, optionally with a name. Example: Support <support@yourdomain.com>.
- `subject` (`string`, optional): Subject line. Can use merge fields such as {firstname}. Required unless the template sets one. Example: Your order has shipped.
- `template_name` (`string`, optional): Name of a saved Elastic Email template to use as the content instead of body_html or body_text. Example: order-shipped.
- `time_offset` (`integer`, optional): Delay sending by this many minutes, up to 35 days. Example: 60.
- `track_clicks` (`boolean`, optional): Track link clicks. When omitted, the account's default applies. Example: true.
- `track_opens` (`boolean`, optional): Track opens. When omitted, the account's default applies. Example: true.
- `utm` (`object`, optional): UTM parameters to add to links, with Source, Medium, Campaign and Content keys. Example: {"Source": "newsletter", "Medium": "email", "Campaign": "fall-sale"}.

Example input: `{"from":"<from>","recipients":[{"Email":"john.doe@example.com","Fields":{"firstname":"John"}}]}`

### `elasticemail_email_transactional_send`

Send Transactional Email · Write

Send one transactional email to To, CC and BCC recipients, who can see the To and CC addresses.
Returns TransactionID and MessageID. Track delivery with elasticemail_email_status_get or elasticemail_email_events_list.
Use elasticemail_email_transactional_send for receipts, notifications and other one-to-one messages. Use elasticemail_email_send when each recipient needs a separate, personalized copy.

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

Inputs:

- `from` (`string`, required): Sender address, optionally with a name, on a domain verified in Elastic Email. Example: John Doe <john@yourdomain.com>.
- `to` (`array`, required): Recipient addresses, visible to each other. Example: ["john.doe@example.com"].
- `attach_files` (`array`, optional): Names of files already uploaded to Elastic Email to attach. Example: ["terms.pdf"].
- `attachments` (`array`, optional): Files to attach, each with a Name and its BinaryContent as a Base64 string, plus an optional ContentType. Example: [{"Name": "invoice.txt", "BinaryContent": "SGVsbG8=", "ContentType": "text/plain"}].
- `bcc` (`array`, optional): Blind carbon-copy addresses, hidden from other recipients. Example: ["archive@example.com"].
- `body_html` (`string`, optional): HTML body. Can use merge fields such as {firstname}. Provide body_html, body_text, or template_name. Example: Hi {firstname}, your order has shipped.
.
- `body_text` (`string`, optional): Plain-text body. Can use merge fields. Example: Hi {firstname}, your order has shipped.
- `cc` (`array`, optional): Carbon-copy addresses, visible to all recipients. Example: ["manager@example.com"].
- `channel_name` (`string`, optional): Channel name used to group this send in statistics and events. Example: order-notifications.
- `encoding` (`string`, optional): Content transfer encoding. Example: QuotedPrintable. One of: `UserProvided`, `None`, `Raw7bit`, `Raw8bit`, `QuotedPrintable`, `Base64`, `Uue`.
- `envelope_from` (`string`, optional): Envelope-from address, optionally with a name. Example: Bounces <bounces@yourdomain.com>.
- `headers` (`object`, optional): Custom email headers, as header-name to value pairs. Example: {"X-Campaign": "fall-sale"}.
- `idempotency_key` (`string`, optional): Key that makes a retry safe: a repeated request with the same key and body returns the stored result instead of sending again. Example: order-12345-shipped.
- `merge` (`object`, optional): Merge fields shared by all recipients, as name to value pairs; use them in the content as {name}. Example: {"company": "Acme"}.
- `pool_name` (`string`, optional): Name of your custom IP pool to send from. Example: marketing-pool.
- `postback` (`string`, optional): Value for the postback header, returned with this message's events and webhooks. Example: order-12345.
- `reply_to` (`string`, optional): Reply-to address, optionally with a name. Example: Support <support@yourdomain.com>.
- `subject` (`string`, optional): Subject line. Can use merge fields such as {firstname}. Required unless the template sets one. Example: Your order has shipped.
- `template_name` (`string`, optional): Name of a saved Elastic Email template to use as the content instead of body_html or body_text. Example: order-shipped.
- `time_offset` (`integer`, optional): Delay sending by this many minutes, up to 35 days. Example: 60.
- `track_clicks` (`boolean`, optional): Track link clicks. When omitted, the account's default applies. Example: true.
- `track_opens` (`boolean`, optional): Track opens. When omitted, the account's default applies. Example: true.
- `utm` (`object`, optional): UTM parameters to add to links, with Source, Medium, Campaign and Content keys. Example: {"Source": "newsletter", "Medium": "email", "Campaign": "fall-sale"}.

Example input: `{"from":"<from>","to":["john.doe@example.com"]}`

### `elasticemail_email_verify`

Verify Email · Write

Verify one email address and spend an Elastic Email verification credit.
Returns Email, Account, Domain, Result (Valid, Invalid, Risky, Unknown or None), Reason, Role, Disposable, SuggestedSpelling, PredictedStatus and PredictedScore.
Use elasticemail_email_verify for a fresh check. Use elasticemail_verification_get to read a past result without spending a credit.

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

Inputs:

- `email` (`string`, required): The email address to verify. Example: john.doe@example.com.

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

### `elasticemail_list_contacts_add`

Add Contacts to List · Write

Put existing contacts on a list, given by email address or by a rule.
Returns the updated list.
Use elasticemail_list_contacts_add for contacts that already exist. Use elasticemail_contacts_add with list_names to create new contacts on a list.

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

Inputs:

- `name` (`string`, required): Name of the list. Example: Newsletter.
- `emails` (`array`, optional): Contact email addresses. Provide emails or rule. Example: ["john.doe@example.com"].
- `rule` (`string`, optional): SQL-like rule selecting contacts instead of listing them, such as Status = 'Engaged'; All selects every contact. Example: Status = 'Engaged'.

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

### `elasticemail_list_create`

Create List · Write

Create a contact list, optionally with existing contacts on it.
Returns the created list.
Use elasticemail_list_create to make a list. Use elasticemail_list_contacts_add to add contacts later.

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

Inputs:

- `list_name` (`string`, required): Name of the new list. Example: Newsletter.
- `allow_unsubscribe` (`boolean`, optional): Allow contacts to unsubscribe from this list. Example: true.
- `emails` (`array`, optional): Email addresses of existing contacts to put on the list. Leave empty for an empty list. Example: ["john.doe@example.com"].

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

### `elasticemail_list_update`

Update List · Write

Rename a list or change whether contacts can unsubscribe from it.
Returns the updated list.
Use elasticemail_list_update to edit a list's settings.

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

Inputs:

- `name` (`string`, required): Name of the list. Example: Newsletter.
- `allow_unsubscribe` (`boolean`, optional): Allow contacts to unsubscribe from this list. Example: false.
- `new_list_name` (`string`, optional): New name for the list. Example: Monthly newsletter.

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

### `elasticemail_segment_create`

Create Segment · Write

Create a segment: a saved rule that picks contacts dynamically.
Returns the created segment.
Use elasticemail_segment_create to target contacts by their data in campaigns.

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

Inputs:

- `rule` (`string`, required): SQL-like rule that selects the segment's contacts. Example: Status = 'Engaged' AND DateAdded > '2026-10-01'.
- `segment_name` (`string`, required): Name of the new segment. Example: Engaged last 30 days.

Example input: `{"rule":"<rule>","segment_name":"<segment_name>"}`

### `elasticemail_segment_update`

Update Segment · Write

Rename a segment or change its rule.
Returns the updated segment.
Use elasticemail_segment_update to edit a segment.

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

Inputs:

- `name` (`string`, required): Name of the segment to update. Example: Engaged last 30 days.
- `rule` (`string`, required): SQL-like rule that selects the segment's contacts. Example: Status = 'Engaged'.
- `segment_name` (`string`, required): Name after the update; use the current name to keep it. Example: Engaged last 60 days.

Example input: `{"name":"<name>","rule":"<rule>","segment_name":"<segment_name>"}`

### `elasticemail_suppression_bounces_add`

Add Bounces · Write

Add email addresses to the account's bounces suppression list so Elastic Email stops sending to them.
Returns the added suppressions.
Use elasticemail_suppression_bounces_add to block addresses you know are bad. Use elasticemail_suppression_delete to remove an address from suppression.

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

Inputs:

- `emails` (`array`, required): Email addresses to add. Example: ["john.doe@example.com"].

Example input: `{"emails":["john.doe@example.com"]}`

### `elasticemail_suppression_complaints_add`

Add Complaints · Write

Add email addresses to the account's complaints suppression list so Elastic Email stops sending to them.
Returns the added suppressions.
Use elasticemail_suppression_complaints_add to block addresses you know are complainers. Use elasticemail_suppression_delete to remove an address from suppression.

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

Inputs:

- `emails` (`array`, required): Email addresses to add. Example: ["john.doe@example.com"].

Example input: `{"emails":["john.doe@example.com"]}`

### `elasticemail_suppression_unsubscribes_add`

Add Unsubscribes · Write

Add email addresses to the account's unsubscribes suppression list so Elastic Email stops sending to them.
Returns the added suppressions.
Use elasticemail_suppression_unsubscribes_add to block addresses you know are unsubscribed. Use elasticemail_suppression_delete to remove an address from suppression.

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

Inputs:

- `emails` (`array`, required): Email addresses to add. Example: ["john.doe@example.com"].

Example input: `{"emails":["john.doe@example.com"]}`

### `elasticemail_template_create`

Create Template · Write

Create an email template with a subject and HTML or plain-text content.
Returns the created template.
Use elasticemail_template_create to save content that sends and campaigns reference by template_name.

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

Inputs:

- `template_name` (`string`, required): Unique name for the template. Example: order-shipped.
- `body_html` (`string`, optional): HTML content. Can use merge fields such as {firstname}. Example: Hi {firstname}
.
- `body_text` (`string`, optional): Plain-text content. Example: Hi {firstname}.
- `subject` (`string`, optional): Default subject line. Example: Your order has shipped.
- `template_scope` (`string`, optional): Personal (this account only) or Global (shared with subaccounts). Example: Personal. One of: `Personal`, `Global`.

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

### `elasticemail_template_update`

Update Template · Write

Overwrite an email template. Fields you leave out are cleared.
Returns the updated template.
Use elasticemail_template_update to change a template; read it with elasticemail_template_get first to keep existing content.

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

Inputs:

- `name` (`string`, required): Name of the template to update. Example: order-shipped.
- `template_name` (`string`, required): Name after the update; use the current name to keep it. Example: order-shipped.
- `body_html` (`string`, optional): HTML content. Can use merge fields such as {firstname}. Example: Hi {firstname}
.
- `body_text` (`string`, optional): Plain-text content. Example: Hi {firstname}.
- `subject` (`string`, optional): Default subject line. Example: Your order has shipped.
- `template_scope` (`string`, optional): Personal (this account only) or Global (shared with subaccounts). Example: Personal. One of: `Personal`, `Global`.

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

### `elasticemail_campaign_delete`

Delete Campaign · Destructive

Delete a campaign. Emails already in progress are not cancelled.
Returns no content on success.
Use elasticemail_campaign_delete to remove a campaign. Use elasticemail_campaign_pause first to stop pending emails.

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

Inputs:

- `name` (`string`, required): Name of the campaign. Example: Fall sale 2026.

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

### `elasticemail_contact_delete`

Delete Contact · Destructive

Delete one contact.
Returns no content on success.
Use elasticemail_contact_delete for one address. Use elasticemail_contacts_delete for many, or elasticemail_list_contacts_remove to only take a contact off a list.

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

Inputs:

- `email` (`string`, required): The contact's email address. Example: john.doe@example.com.

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

### `elasticemail_contacts_delete`

Delete Contacts · Destructive

Delete many contacts at once, given by email address or by a rule.
Returns no content on success.
Use elasticemail_contacts_delete for bulk deletes. Use elasticemail_contact_delete for one address.

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

Inputs:

- `emails` (`array`, optional): Contact email addresses. Provide emails or rule. Example: ["john.doe@example.com"].
- `rule` (`string`, optional): SQL-like rule selecting contacts instead of listing them, such as Status = 'Engaged'; All selects every contact. Example: Status = 'Engaged'.

Example input: `{}`

### `elasticemail_list_contacts_remove`

Remove Contacts from List · Destructive

Take contacts off a list, given by email address or by a rule. The contacts are kept.
Returns no content on success.
Use elasticemail_list_contacts_remove to change list membership. Use elasticemail_contacts_delete to delete contacts.

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

Inputs:

- `name` (`string`, required): Name of the list. Example: Newsletter.
- `emails` (`array`, optional): Contact email addresses. Provide emails or rule. Example: ["john.doe@example.com"].
- `rule` (`string`, optional): SQL-like rule selecting contacts instead of listing them, such as Status = 'Engaged'; All selects every contact. Example: Status = 'Engaged'.

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

### `elasticemail_list_delete`

Delete List · Destructive

Delete a list. The contacts on it are kept.
Returns no content on success.
Use elasticemail_list_delete to remove a list. Use elasticemail_contacts_delete to delete the contacts themselves.

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

Inputs:

- `name` (`string`, required): Name of the list. Example: Newsletter.

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

### `elasticemail_segment_delete`

Delete Segment · Destructive

Delete a segment. Contacts are not affected.
Returns no content on success.
Use elasticemail_segment_delete to remove a segment.

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

Inputs:

- `name` (`string`, required): Name of the segment. Example: Engaged last 30 days.

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

### `elasticemail_suppression_delete`

Delete Suppression · Destructive

Remove an address from suppression so Elastic Email can send to it again.
Returns no content on success.
Use elasticemail_suppression_delete only when the address is known to be good again.

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

Inputs:

- `email` (`string`, required): The email address to remove from suppression. Example: john.doe@example.com.

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

### `elasticemail_template_delete`

Delete Template · Destructive

Delete an email template.
Returns no content on success.
Use elasticemail_template_delete to remove a template you no longer use.

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

Inputs:

- `name` (`string`, required): Name of the template. Example: order-shipped.

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

### `elasticemail_verification_delete`

Delete Verification Result · Destructive

Delete the stored verification result for one address.
Returns no content on success.
Use elasticemail_verification_delete to remove a stored result.

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

Inputs:

- `email` (`string`, required): The verified email address. Example: john.doe@example.com.

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

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