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.
- Tools
- 60
- What they doRead · write · destructive
- 30 · 21 · 930 read21 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Elastic Email connection
In AgentKit > Connections, create an Elastic Email connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'elasticemail'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'elasticemail_account_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "elasticemail"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="elasticemail_account_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Elastic Email credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolelasticemail_account_getGet public information about the Elastic Email account that owns the API key.Read-onlyGet Account
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.
Inputs
This tool takes no inputs.
elasticemail_campaign_getGet one campaign by name.Read-onlyGet Campaign
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.
Inputs
namestringrequired- Name of the campaign. Example: Fall sale 2026.
elasticemail_campaign_stats_getGet sending statistics for one campaign.Read-onlyGet Campaign Stats
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.
Inputs
namestringrequired- Name of the campaign. Example: Fall sale 2026.
elasticemail_campaign_stats_listList sending statistics for every campaign.Read-onlyList Campaign Stats
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_campaigns_listList the account's campaigns, optionally filtered by a fragment of the name (up to 1,000).Read-onlyList Campaigns
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
searchstring- Return campaigns whose name contains this text. Example: fall.
elasticemail_channel_events_listList delivery events for one channel, filtered by type and date (up to 1,000 per call).Read-onlyList Channel Events
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.
Inputs
namestringrequired- Name of the channel. Example: order-notifications.
event_typesarray- Only return events of these types. Example: ["Bounce", "Complaint"].
fromstring- Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
limitinteger- Maximum number of items to return. Up to 1000. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
order_bystring- Sort order by event date. Defaults to DateDescending. Example: DateAscending.one of
DateDescendingDateAscending tostring- End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.
elasticemail_channel_stats_getGet sending statistics for one channel (the channel_name given on sends).Read-onlyGet Channel Stats
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.
Inputs
namestringrequired- Name of the channel. Example: order-notifications.
elasticemail_channel_stats_listList sending statistics for every channel.Read-onlyList Channel Stats
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_contact_getGet one contact by email address.Read-onlyGet Contact
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.
Inputs
emailstringrequired- The contact's email address. Example: john.doe@example.com.
elasticemail_contacts_export_status_getGet the status of a contacts export.Read-onlyGet Contacts Export Status
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.
Inputs
export_idstringrequired- ID of the export, returned by elasticemail_contacts_export. Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6.
elasticemail_contacts_listList the account's contacts, one page at a time.Read-onlyList Contacts
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.
Inputs
limitinteger- Maximum number of items to return. Defaults to 20. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_email_events_listList the delivery events of one send by its transaction ID.Read-onlyList Email Events
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.
Inputs
transaction_idstringrequired- Transaction ID returned by a send tool. Example: 5c2d4a3f-9e1b-4b8a-a0a3-2f7f5e9c1d22.
fromstring- Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
order_bystring- Sort order by event date. Defaults to DateDescending. Example: DateAscending.one of
DateDescendingDateAscending tostring- End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.
elasticemail_email_status_getGet the delivery status of a send by its transaction ID, with optional lists of addresses in each state.Read-onlyGet Email Status
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.
Inputs
transaction_idstringrequired- Transaction ID returned by a send tool. Example: 5c2d4a3f-9e1b-4b8a-a0a3-2f7f5e9c1d22.
show_abuseboolean- Set true to include the addresses that reported abuse. Defaults to false. Example: true.
show_clickedboolean- Set true to include the addresses that clicked. Defaults to false. Example: true.
show_deliveredboolean- Set true to include the delivered addresses. Defaults to false. Example: true.
show_errorsboolean- Set true to include the error messages for bounced emails. Defaults to false. Example: true.
show_failedboolean- Set true to include the bounced addresses. Defaults to false. Example: true.
show_message_idsboolean- Set true to include the message IDs. Defaults to false. Example: true.
show_openedboolean- Set true to include the addresses that opened. Defaults to false. Example: true.
show_pendingboolean- Set true to include the addresses waiting to send. Defaults to false. Example: true.
show_sentboolean- Set true to include the sent addresses. Defaults to false. Example: true.
show_unsubscribedboolean- Set true to include the unsubscribed addresses. Defaults to false. Example: true.
elasticemail_email_viewGet the content of one sent email by its message ID, for viewing or rendering.Read-onlyView Email
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.
Inputs
message_idstringrequired- Message ID of the email, from a send response or an event. Example: hR8kL2mN4pQ6rS8tU0vW2x.
elasticemail_events_listList delivery events across the account, such as sends, opens, clicks, bounces and complaints, filtered by type and date (up to 1,000 per call).Read-onlyList Events
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.
Inputs
event_typesarray- Only return events of these types. Example: ["Bounce", "Complaint"].
fromstring- Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
limitinteger- Maximum number of items to return. Up to 1000. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
order_bystring- Sort order by event date. Defaults to DateDescending. Example: DateAscending.one of
DateDescendingDateAscending tostring- End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.
elasticemail_list_contacts_listList the contacts on one list.Read-onlyList Contacts in List
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.
Inputs
namestringrequired- Name of the list. Example: Newsletter.
limitinteger- Maximum number of items to return. Defaults to 20. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_list_getGet one contact list by name.Read-onlyGet List
Get one contact list by name. Returns ListName, PublicListID, DateAdded and AllowUnsubscribe. Use elasticemail_list_get for a known list.
Inputs
namestringrequired- Name of the list. Example: Newsletter.
elasticemail_lists_listList the account's contact lists.Read-onlyList Lists
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_segment_getGet one segment by name.Read-onlyGet Segment
Get one segment by name. The name All Contacts returns every contact. Returns Name and Rule. Use elasticemail_segment_get for a known segment.
Inputs
namestringrequired- Name of the segment. Example: Engaged last 30 days.
elasticemail_segments_listList the account's segments.Read-onlyList Segments
List the account's segments. Returns segments with Name and Rule. Use elasticemail_segments_list to find segment names for campaigns.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_statistics_getGet the account's sending statistics for a time range.Read-onlyGet Statistics
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.
Inputs
fromstringrequired- Start of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-01T00:00:00.
tostring- End of the time range, as YYYY-MM-DDThh:mm:ss. Example: 2026-11-13T23:59:59.
elasticemail_suppression_bounces_listList the account's bounces suppressions, optionally searched by text.Read-onlyList Bounces
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
searchstring- Text fragment to search for. Example: example.com.
elasticemail_suppression_complaints_listList the account's complaints suppressions, optionally searched by text.Read-onlyList Complaints
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
searchstring- Text fragment to search for. Example: example.com.
elasticemail_suppression_getCheck whether one address is suppressed, and why.Read-onlyGet Suppression
Check whether one address is suppressed, and why. Returns Email, FriendlyErrorMessage, ErrorCode and DateUpdated. Use elasticemail_suppression_get to check an address before sending.
Inputs
emailstringrequired- The email address to check. Example: john.doe@example.com.
elasticemail_suppression_unsubscribes_listList the account's unsubscribes suppressions, optionally searched by text.Read-onlyList Unsubscribes
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
searchstring- Text fragment to search for. Example: example.com.
elasticemail_suppressions_listList every suppressed address on the account: bounces, complaints and unsubscribes.Read-onlyList Suppressions
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_template_getGet one email template by name.Read-onlyGet Template
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.
Inputs
namestringrequired- Name of the template. Example: order-shipped.
elasticemail_templates_listList email templates by scope and, optionally, type.Read-onlyList Templates
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.
Inputs
scope_typearrayrequired- Template scopes to return: Personal, Global, or both. Example: ["Personal"].
limitinteger- Maximum number of items to return. Defaults to 500. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
template_typesarray- Only return templates of these types. Example: ["RawHTML", "DragDropEditor"].
elasticemail_verification_getGet the stored result of an earlier single-email verification.Read-onlyGet Verification Result
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.
Inputs
emailstringrequired- The verified email address. Example: john.doe@example.com.
elasticemail_verifications_listList the stored results of single-email verifications.Read-onlyList Verification Results
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.
Inputs
limitinteger- Maximum number of items to return. Example: 50.
offsetinteger- Number of items to skip, for paging. Example: 50.
elasticemail_automation_triggerStart an automation for one contact by hand.WriteTrigger Automation
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.
Inputs
contact_emailstringrequired- Email address of the contact to start the automation for. Example: john.doe@example.com.
namestringrequired- Name of the automation. Example: Welcome series.
elasticemail_campaign_createCreate a campaign that sends to saved lists or segments.WriteCreate Campaign
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.
Inputs
campaign_namestringrequired- Unique name for the campaign. Example: Fall sale 2026.
contentarray- 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_namesarray- Names of lists whose contacts are left out. Example: ["Do not email"].
excluded_segment_namesarray- Names of segments whose contacts are left out. Example: ["Bounced"].
list_namesarray- Names of contact lists to send to. Provide list_names, segment_names, or both. Example: ["Newsletter"].
optionsobject- 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_namesarray- Names of segments to send to. Example: ["Engaged last 30 days"].
statusstring- Campaign status. Draft saves it without sending; Active starts it (or schedules it when options set ScheduleFor). Example: Draft.one of
DraftActivePausedCancelledDeletedProcessingSendingCompleted
elasticemail_campaign_pausePause a campaign and cancel the emails still waiting to be sent.WritePause Campaign
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.
- Idempotent
Inputs
namestringrequired- Name of the campaign. Example: Fall sale 2026.
elasticemail_campaign_updateReplace a campaign's settings.WriteUpdate Campaign
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.
- Idempotent
Inputs
campaign_namestringrequired- Name to give the campaign, which can rename it. Use the current name to keep it. Example: Fall sale 2026.
namestringrequired- Name of the campaign to update. Example: Fall sale 2026.
contentarray- 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_namesarray- Names of lists whose contacts are left out. Example: ["Do not email"].
excluded_segment_namesarray- Names of segments whose contacts are left out. Example: ["Bounced"].
list_namesarray- Names of contact lists to send to. Provide list_names, segment_names, or both. Example: ["Newsletter"].
optionsobject- 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_namesarray- Names of segments to send to. Example: ["Engaged last 30 days"].
statusstring- Campaign status. Draft saves it without sending; Active starts it (or schedules it when options set ScheduleFor). Example: Draft.one of
DraftActivePausedCancelledDeletedProcessingSendingCompleted
elasticemail_contact_updateUpdate a contact's name or custom fields.WriteUpdate Contact
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.
- Idempotent
Inputs
emailstringrequired- The contact's email address. Example: john.doe@example.com.
custom_fieldsobject- Custom field values to set, as field-name to value pairs. Example: {"city": "Austin"}.
first_namestring- New first name. Example: John.
last_namestring- New last name. Example: Doe.
elasticemail_contacts_addAdd up to 1,000 new contacts, optionally to one or more lists.WriteAdd Contacts
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.
Inputs
contactsarrayrequired- 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_namesarray- Names of lists to add the new contacts to. Example: ["Newsletter"].
elasticemail_contacts_exportStart an export of contacts to a downloadable file, all of them or those matching a rule or list of emails.WriteExport Contacts
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.
Inputs
compression_formatstring- None or Zip. Example: Zip.one of
NoneZip emailsarray- Email addresses of the contacts to export. Example: ["john.doe@example.com"].
file_formatstring- File format. Defaults to Csv. Example: Csv.one of
CsvXmlJson file_namestring- File name, including the extension. Example: contacts.csv.
rulestring- SQL-like rule selecting the contacts to export. Example: Status = 'Engaged'.
elasticemail_email_mergefile_sendSend 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.WriteSend Email to CSV
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.
Inputs
fromstringrequired- Sender address, optionally with a name, on a domain verified in Elastic Email. Example: John Doe <john@yourdomain.com>.
merge_file_contentstringrequired- 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_namestringrequired- File name for the CSV. Example: recipients.csv.
attach_filesarray- Names of files already uploaded to Elastic Email to attach. Example: ["terms.pdf"].
attachmentsarray- 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_htmlstring- HTML body. Can use merge fields such as {firstname}. Provide body_html, body_text, or template_name. Example: <p>Hi {firstname}, your order has shipped.</p>.
body_textstring- Plain-text body. Can use merge fields. Example: Hi {firstname}, your order has shipped.
channel_namestring- Channel name used to group this send in statistics and events. Example: order-notifications.
encodingstring- Content transfer encoding. Example: QuotedPrintable.one of
UserProvidedNoneRaw7bitRaw8bitQuotedPrintableBase64Uue envelope_fromstring- Envelope-from address, optionally with a name. Example: Bounces <bounces@yourdomain.com>.
headersobject- Custom email headers, as header-name to value pairs. Example: {"X-Campaign": "fall-sale"}.
idempotency_keystring- 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.
mergeobject- Merge fields shared by all recipients, as name to value pairs; use them in the content as {name}. Example: {"company": "Acme"}.
pool_namestring- Name of your custom IP pool to send from. Example: marketing-pool.
postbackstring- Value for the postback header, returned with this message's events and webhooks. Example: order-12345.
reply_tostring- Reply-to address, optionally with a name. Example: Support <support@yourdomain.com>.
subjectstring- Subject line. Can use merge fields such as {firstname}. Required unless the template sets one. Example: Your order has shipped.
template_namestring- Name of a saved Elastic Email template to use as the content instead of body_html or body_text. Example: order-shipped.
time_offsetinteger- Delay sending by this many minutes, up to 35 days. Example: 60.
track_clicksboolean- Track link clicks. When omitted, the account's default applies. Example: true.
track_opensboolean- Track opens. When omitted, the account's default applies. Example: true.
utmobject- UTM parameters to add to links, with Source, Medium, Campaign and Content keys. Example: {"Source": "newsletter", "Medium": "email", "Campaign": "fall-sale"}.
elasticemail_email_sendSend an email to one or more recipients, each receiving their own copy with personal merge fields.WriteSend Bulk Email
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.
Inputs
fromstringrequired- Sender address, optionally with a name, on a domain verified in Elastic Email. Example: John Doe <john@yourdomain.com>.
recipientsarrayrequired- 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_filesarray- Names of files already uploaded to Elastic Email to attach. Example: ["terms.pdf"].
attachmentsarray- 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_htmlstring- HTML body. Can use merge fields such as {firstname}. Provide body_html, body_text, or template_name. Example: <p>Hi {firstname}, your order has shipped.</p>.
body_textstring- Plain-text body. Can use merge fields. Example: Hi {firstname}, your order has shipped.
channel_namestring- Channel name used to group this send in statistics and events. Example: order-notifications.
encodingstring- Content transfer encoding. Example: QuotedPrintable.one of
UserProvidedNoneRaw7bitRaw8bitQuotedPrintableBase64Uue envelope_fromstring- Envelope-from address, optionally with a name. Example: Bounces <bounces@yourdomain.com>.
headersobject- Custom email headers, as header-name to value pairs. Example: {"X-Campaign": "fall-sale"}.
idempotency_keystring- 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.
mergeobject- Merge fields shared by all recipients, as name to value pairs; use them in the content as {name}. Example: {"company": "Acme"}.
pool_namestring- Name of your custom IP pool to send from. Example: marketing-pool.
postbackstring- Value for the postback header, returned with this message's events and webhooks. Example: order-12345.
reply_tostring- Reply-to address, optionally with a name. Example: Support <support@yourdomain.com>.
subjectstring- Subject line. Can use merge fields such as {firstname}. Required unless the template sets one. Example: Your order has shipped.
template_namestring- Name of a saved Elastic Email template to use as the content instead of body_html or body_text. Example: order-shipped.
time_offsetinteger- Delay sending by this many minutes, up to 35 days. Example: 60.
track_clicksboolean- Track link clicks. When omitted, the account's default applies. Example: true.
track_opensboolean- Track opens. When omitted, the account's default applies. Example: true.
utmobject- UTM parameters to add to links, with Source, Medium, Campaign and Content keys. Example: {"Source": "newsletter", "Medium": "email", "Campaign": "fall-sale"}.
elasticemail_email_transactional_sendSend one transactional email to To, CC and BCC recipients, who can see the To and CC addresses.WriteSend Transactional Email
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.
Inputs
fromstringrequired- Sender address, optionally with a name, on a domain verified in Elastic Email. Example: John Doe <john@yourdomain.com>.
toarrayrequired- Recipient addresses, visible to each other. Example: ["john.doe@example.com"].
attach_filesarray- Names of files already uploaded to Elastic Email to attach. Example: ["terms.pdf"].
attachmentsarray- 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"}].
bccarray- Blind carbon-copy addresses, hidden from other recipients. Example: ["archive@example.com"].
body_htmlstring- HTML body. Can use merge fields such as {firstname}. Provide body_html, body_text, or template_name. Example: <p>Hi {firstname}, your order has shipped.</p>.
body_textstring- Plain-text body. Can use merge fields. Example: Hi {firstname}, your order has shipped.
ccarray- Carbon-copy addresses, visible to all recipients. Example: ["manager@example.com"].
channel_namestring- Channel name used to group this send in statistics and events. Example: order-notifications.
encodingstring- Content transfer encoding. Example: QuotedPrintable.one of
UserProvidedNoneRaw7bitRaw8bitQuotedPrintableBase64Uue envelope_fromstring- Envelope-from address, optionally with a name. Example: Bounces <bounces@yourdomain.com>.
headersobject- Custom email headers, as header-name to value pairs. Example: {"X-Campaign": "fall-sale"}.
idempotency_keystring- 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.
mergeobject- Merge fields shared by all recipients, as name to value pairs; use them in the content as {name}. Example: {"company": "Acme"}.
pool_namestring- Name of your custom IP pool to send from. Example: marketing-pool.
postbackstring- Value for the postback header, returned with this message's events and webhooks. Example: order-12345.
reply_tostring- Reply-to address, optionally with a name. Example: Support <support@yourdomain.com>.
subjectstring- Subject line. Can use merge fields such as {firstname}. Required unless the template sets one. Example: Your order has shipped.
template_namestring- Name of a saved Elastic Email template to use as the content instead of body_html or body_text. Example: order-shipped.
time_offsetinteger- Delay sending by this many minutes, up to 35 days. Example: 60.
track_clicksboolean- Track link clicks. When omitted, the account's default applies. Example: true.
track_opensboolean- Track opens. When omitted, the account's default applies. Example: true.
utmobject- UTM parameters to add to links, with Source, Medium, Campaign and Content keys. Example: {"Source": "newsletter", "Medium": "email", "Campaign": "fall-sale"}.
elasticemail_email_verifyVerify one email address and spend an Elastic Email verification credit.WriteVerify Email
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.
Inputs
emailstringrequired- The email address to verify. Example: john.doe@example.com.
elasticemail_list_contacts_addPut existing contacts on a list, given by email address or by a rule.WriteAdd Contacts to List
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.
- Idempotent
Inputs
namestringrequired- Name of the list. Example: Newsletter.
emailsarray- Contact email addresses. Provide emails or rule. Example: ["john.doe@example.com"].
rulestring- SQL-like rule selecting contacts instead of listing them, such as Status = 'Engaged'; All selects every contact. Example: Status = 'Engaged'.
elasticemail_list_createCreate a contact list, optionally with existing contacts on it.WriteCreate List
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.
Inputs
list_namestringrequired- Name of the new list. Example: Newsletter.
allow_unsubscribeboolean- Allow contacts to unsubscribe from this list. Example: true.
emailsarray- Email addresses of existing contacts to put on the list. Leave empty for an empty list. Example: ["john.doe@example.com"].
elasticemail_list_updateRename a list or change whether contacts can unsubscribe from it.WriteUpdate List
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.
- Idempotent
Inputs
namestringrequired- Name of the list. Example: Newsletter.
allow_unsubscribeboolean- Allow contacts to unsubscribe from this list. Example: false.
new_list_namestring- New name for the list. Example: Monthly newsletter.
elasticemail_segment_createCreate a segment: a saved rule that picks contacts dynamically.WriteCreate Segment
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.
Inputs
rulestringrequired- SQL-like rule that selects the segment's contacts. Example: Status = 'Engaged' AND DateAdded > '2026-10-01'.
segment_namestringrequired- Name of the new segment. Example: Engaged last 30 days.
elasticemail_segment_updateRename a segment or change its rule.WriteUpdate Segment
Rename a segment or change its rule. Returns the updated segment. Use elasticemail_segment_update to edit a segment.
- Idempotent
Inputs
namestringrequired- Name of the segment to update. Example: Engaged last 30 days.
rulestringrequired- SQL-like rule that selects the segment's contacts. Example: Status = 'Engaged'.
segment_namestringrequired- Name after the update; use the current name to keep it. Example: Engaged last 60 days.
elasticemail_suppression_bounces_addAdd email addresses to the account's bounces suppression list so Elastic Email stops sending to them.WriteAdd Bounces
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.
Inputs
emailsarrayrequired- Email addresses to add. Example: ["john.doe@example.com"].
elasticemail_suppression_complaints_addAdd email addresses to the account's complaints suppression list so Elastic Email stops sending to them.WriteAdd Complaints
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.
Inputs
emailsarrayrequired- Email addresses to add. Example: ["john.doe@example.com"].
elasticemail_suppression_unsubscribes_addAdd email addresses to the account's unsubscribes suppression list so Elastic Email stops sending to them.WriteAdd Unsubscribes
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.
Inputs
emailsarrayrequired- Email addresses to add. Example: ["john.doe@example.com"].
elasticemail_template_createCreate an email template with a subject and HTML or plain-text content.WriteCreate Template
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.
Inputs
template_namestringrequired- Unique name for the template. Example: order-shipped.
body_htmlstring- HTML content. Can use merge fields such as {firstname}. Example: <p>Hi {firstname}</p>.
body_textstring- Plain-text content. Example: Hi {firstname}.
subjectstring- Default subject line. Example: Your order has shipped.
template_scopestring- Personal (this account only) or Global (shared with subaccounts). Example: Personal.one of
PersonalGlobal
elasticemail_template_updateOverwrite an email template.WriteUpdate Template
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.
- Idempotent
Inputs
namestringrequired- Name of the template to update. Example: order-shipped.
template_namestringrequired- Name after the update; use the current name to keep it. Example: order-shipped.
body_htmlstring- HTML content. Can use merge fields such as {firstname}. Example: <p>Hi {firstname}</p>.
body_textstring- Plain-text content. Example: Hi {firstname}.
subjectstring- Default subject line. Example: Your order has shipped.
template_scopestring- Personal (this account only) or Global (shared with subaccounts). Example: Personal.one of
PersonalGlobal
elasticemail_campaign_deleteDelete a campaign.DestructiveDelete Campaign
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.
- Idempotent
Inputs
namestringrequired- Name of the campaign. Example: Fall sale 2026.
elasticemail_contact_deleteDelete one contact.DestructiveDelete Contact
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.
- Idempotent
Inputs
emailstringrequired- The contact's email address. Example: john.doe@example.com.
elasticemail_contacts_deleteDelete many contacts at once, given by email address or by a rule.DestructiveDelete Contacts
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.
- Idempotent
Inputs
emailsarray- Contact email addresses. Provide emails or rule. Example: ["john.doe@example.com"].
rulestring- SQL-like rule selecting contacts instead of listing them, such as Status = 'Engaged'; All selects every contact. Example: Status = 'Engaged'.
elasticemail_list_contacts_removeTake contacts off a list, given by email address or by a rule.DestructiveRemove Contacts from List
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.
- Idempotent
Inputs
namestringrequired- Name of the list. Example: Newsletter.
emailsarray- Contact email addresses. Provide emails or rule. Example: ["john.doe@example.com"].
rulestring- SQL-like rule selecting contacts instead of listing them, such as Status = 'Engaged'; All selects every contact. Example: Status = 'Engaged'.
elasticemail_list_deleteDelete a list.DestructiveDelete List
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.
- Idempotent
Inputs
namestringrequired- Name of the list. Example: Newsletter.
elasticemail_segment_deleteDelete a segment.DestructiveDelete Segment
Delete a segment. Contacts are not affected. Returns no content on success. Use elasticemail_segment_delete to remove a segment.
- Idempotent
Inputs
namestringrequired- Name of the segment. Example: Engaged last 30 days.
elasticemail_suppression_deleteRemove an address from suppression so Elastic Email can send to it again.DestructiveDelete Suppression
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.
- Idempotent
Inputs
emailstringrequired- The email address to remove from suppression. Example: john.doe@example.com.
elasticemail_template_deleteDelete an email template.DestructiveDelete Template
Delete an email template. Returns no content on success. Use elasticemail_template_delete to remove a template you no longer use.
- Idempotent
Inputs
namestringrequired- Name of the template. Example: order-shipped.
elasticemail_verification_deleteDelete the stored verification result for one address.DestructiveDelete Verification Result
Delete the stored verification result for one address. Returns no content on success. Use elasticemail_verification_delete to remove a stored result.
- Idempotent
Inputs
emailstringrequired- The verified email address. Example: john.doe@example.com.
No tools match.