Back to Browse

Sequenzy MCP Server

Developer ToolsModerate5.8MCP RegistryLocalRemote
Free

Server data from the Official MCP Registry

Sequenzy MCP server for AI-powered email marketing automation.

About

Sequenzy MCP server for AI-powered email marketing automation.

Remote endpoints: streamable-http: https://api.sequenzy.com/v1/mcp

Security Report

5.8
Moderate5.8Moderate Risk

This MCP server for Sequenzy email marketing is well-structured with proper authentication via required API keys and appropriate permission scoping. The codebase demonstrates good security practices with environment variable-based credential handling, clear tool annotations for authorization levels, and no evidence of malicious patterns. Minor code quality observations around broad error handling and extensive tool definitions do not materially impact security. Supply chain analysis found 2 known vulnerabilities in dependencies (0 critical, 2 high severity).

3 files analyzed · 6 issues found

Security scores are indicators to help you make informed decisions, not guarantees. Always review permissions before connecting any MCP server.

Permissions Required

This plugin requests these system permissions. Most are normal for its category.

env_vars

Check that this permission is expected for this type of plugin.

HTTP Network Access

Connects to external APIs or services over the internet.

How to Install & Connect

Available as Local & Remote

This plugin can run on your machine or connect to a hosted endpoint. during install.

Documentation

View on GitHub

From the project's GitHub README.

Sequenzy MCP Server

Official MCP server for Sequenzy, the AI-powered email marketing platform.

Connect Sequenzy to Claude Desktop, Claude Code, Codex, Cursor, Windsurf, VS Code Copilot, OpenClaw, and other MCP clients so your AI assistant can manage email operations with structured tools instead of hand-written API calls.

What You Can Do

  • Manage subscribers, tags, lists, and dynamic segments, including bulk tag reconciliation and synthetic event testing.
  • Sync segments to Meta custom audiences for Facebook and Instagram retargeting.
  • Manage products and attach digital delivery files for purchase automations.
  • Upload hosted email images with alt text and reusable responsive crop settings.
  • Draft, update, schedule, and inspect campaigns, including resolved audience previews, persisted conversion goals, and From, Reply-To, CC, and BCC identities.
  • Render campaigns, sequence steps, and templates to their exact email-safe HTML without sending.
  • Add one-click Poll and NPS survey blocks to emails and inspect campaign response summaries.
  • Create and edit email sequences, including multi-list/tag triggers, entry-audience and property-filtered stop conditions, sending identity overrides, existing graph restructuring, and direct step test sends to internal reviewers.
  • Cancel, pause, resume, duplicate, or delete campaigns and enroll contacts into sequences.
  • Manage transactional email templates and send transactional emails to shared To, Cc, and Bcc recipient lists.
  • Supply localized template variants or queue AI translation for enabled locales.
  • Create, preview, edit, publish, unpublish, and delete landing pages.
  • Create list-scoped saved signup forms with responsive stack, row, grid, and single-image overlay block groups (including foreground gap controls), then return client-safe static-site embeds.
  • Create, target, publish, duplicate, and deploy saved signup popups with the same recursive block layouts.
  • Connect and verify custom domains for published landing pages.
  • Manage team invitations, inbox conversations, and outbound webhook endpoints.
  • Generate email copy, subject lines, and multi-step sequences.
  • Inspect analytics, subscriber activity, deliverability health, company-level sending pauses, integrations, published event payload schemas, sending identities, tracking settings, and dashboard URLs.
  • Diagnose why sending is paused and restore eligible hard-bounce pauses after confirming list cleanup.
  • Inspect exact-recipient bounce, complaint, and email-hygiene suppression, and clean up eligible stale bounces without exposing the shared SES suppression list.
  • Configure company product info, account-wide sending identity defaults, rename individual sender and reply-to profiles, manage sender domains, and inspect integration examples for common frameworks.

Every published MCP tool includes explicit readOnlyHint, destructiveHint, and openWorldHint annotations so compatible clients can display accurate tool-use affordances. Tools also publish outputSchema definitions and return structuredContent, giving clients and models machine-readable result shapes for follow-up calls.

Quick Setup

The easiest setup path is the Sequenzy wizard:

npx @sequenzy/setup

The wizard opens the browser login flow, creates a personal API key, detects supported AI clients, and configures them automatically when possible.

Hosted Remote MCP

For clients that support Streamable HTTP MCP, use Sequenzy's hosted endpoint instead of running a local stdio process:

https://api.sequenzy.com/v1/mcp

Remote clients should authenticate with the Sequenzy OAuth flow when supported. Local and automation clients can still use the stdio package below with SEQUENZY_API_KEY.

The hosted endpoint and the stdio package support MCP specification 2026-07-28 while remaining compatible with 2025-era clients. Modern HTTP clients use per-request discovery and method headers; existing clients keep working through the same endpoint and package command.

Machine-readable discovery files:

Manual Setup

All stdio MCP clients use the same command:

  • Command: npx
  • Args: -y @sequenzy/mcp
  • Required env: SEQUENZY_API_KEY=seq_user_your_key_here

Optional environment variables:

  • SEQUENZY_API_URL - Sequenzy API base URL. Defaults to https://api.sequenzy.com.
  • SEQUENZY_APP_URL - Sequenzy dashboard base URL used by app URL helpers. Defaults to https://sequenzy.com.

Claude Desktop

Add this to your Claude Desktop config:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "sequenzy": {
      "command": "npx",
      "args": ["-y", "@sequenzy/mcp"],
      "env": {
        "SEQUENZY_API_KEY": "seq_user_your_key_here"
      }
    }
  }
}

Restart Claude Desktop after editing the config.

Claude Code

claude mcp add --scope user --env=SEQUENZY_API_KEY=seq_user_your_key_here sequenzy -- npx -y @sequenzy/mcp

On native Windows, wrap npx with cmd /c:

claude mcp add --scope user --env=SEQUENZY_API_KEY=seq_user_your_key_here sequenzy -- cmd /c npx -y @sequenzy/mcp

For a shared project config, use .mcp.json:

{
  "mcpServers": {
    "sequenzy": {
      "command": "npx",
      "args": ["-y", "@sequenzy/mcp"],
      "env": {
        "SEQUENZY_API_KEY": "seq_user_your_key_here"
      }
    }
  }
}

Codex

codex mcp add sequenzy --env SEQUENZY_API_KEY=seq_user_your_key_here -- npx -y @sequenzy/mcp
codex mcp list

Manual Codex config in ~/.codex/config.toml:

[mcp_servers.sequenzy]
command = "npx"
args = ["-y", "@sequenzy/mcp"]

[mcp_servers.sequenzy.env]
SEQUENZY_API_KEY = "seq_user_your_key_here"

Cursor

Install Sequenzy from the Cursor Marketplace for a hosted connection with Sequenzy OAuth. The plugin connects to:

https://api.sequenzy.com/v1/mcp

After installing, complete the browser sign-in flow. Cursor's agent can then use Sequenzy tools from chat, including when Grok is the selected model.

For a manual local stdio setup instead, add this to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "sequenzy": {
      "command": "npx",
      "args": ["-y", "@sequenzy/mcp"],
      "env": {
        "SEQUENZY_API_KEY": "seq_user_your_key_here"
      }
    }
  }
}

Windsurf

Use the same JSON shape as Cursor.

  • macOS: ~/Library/Application Support/Windsurf/mcp.json
  • Windows: %APPDATA%\Windsurf\mcp.json

VS Code Copilot

VS Code uses a servers object:

{
  "servers": {
    "sequenzy": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@sequenzy/mcp"],
      "env": {
        "SEQUENZY_API_KEY": "seq_user_your_key_here"
      }
    }
  }
}

Other MCP Clients

For OpenClaw, Hermes, and other MCP-compatible clients, point the client at npx -y @sequenzy/mcp and set SEQUENZY_API_KEY.

Getting an API Key

  1. Open the Sequenzy dashboard.
  2. Use the MCP setup flow to create a personal key, or open Settings -> API Keys to create a company key.
  3. Choose a permission preset or the exact custom scopes the integration needs.
  4. Add the key to your MCP client config.

Personal keys start with seq_user_. You can revoke them any time in the dashboard.

Company keys can also be cleaned up without exposing secrets. Call list_api_keys to compare the key ID, name, non-secret prefix, permissions, last-use timestamp, and isCurrent marker, then pass the exact ID to revoke_api_key. delete_api_key is a compatibility alias for the same permanent operation. List and revoke responses never contain the plain key or stored key hash.

Recover from missing API key permissions

If a tool reports a missing scope such as campaigns:read or templates:write, call get_account. Its apiKeyPermissions field lists the current key identity and type, scopes, common missing marketing read scopes, and a direct manageUrl. Personal keys open Account API Keys; company keys open the selected workspace's API Keys settings. If the key does not include account:read, open the Sequenzy dashboard directly and choose the matching API Keys page.

Permissions are editable in place, so open manageUrl, update the active key, and retry the failed tool without replacing the credential or restarting the client. An agent using a company key with api_keys:manage can instead call update_api_key; personal keys must be edited on the account-level page because that tool only manages company keys. Its scopes and preset inputs replace the whole permission selection rather than merging, so preserve every existing scope that is still needed. Hosted OAuth connections can alternatively disconnect and reauthorize with broader permissions.

When the active key itself lacks api_keys:manage, call request_api_key_handoff instead of retrying update_api_key. It requires account:read and returns an owner-review URL with the requested key name, permissions, and optional predecessor prefilled. It never creates or returns a key; the workspace owner reviews the form, creates the replacement in the browser, and copies it into the client. Pass replaceApiKeyId: "current" to offer revocation of the active key after the replacement is created. If the active key also lacks account:read, use the dashboard directly.

The default Safer agent access preset includes lists:write and tags:write, so agents can create and update list and tag definitions, and it includes subscribers:tag for applying tags to existing contacts. It also includes ab_tests:read, ab_tests:write, and sequences:write, so agents can audit and edit sequence A/B variant copy, including cart and browse abandonment messages. It does not include subscribers:write, so it cannot add contacts to lists or remove them from lists. Deleting a list or tag still requires the matching lists:delete or tags:delete permission.

The AI drafting preset includes subscribers:write, so drafting agents can build a list as well as create it. Imports that apply listIds also need lists:write; sequence enrollment or double-opt-in delivery additionally needs automations:trigger.

Tools

This server currently exposes 232 MCP tools.

Tools reject arguments they do not declare instead of silently ignoring them. Errors name the unsupported fields, list the supported arguments, and provide focused guidance for common mistakes such as invented subscriber filters or sort options.

Account, Companies, Setup

ToolDescription
get_accountGet account info, available companies, current key permissions, and the API Keys management URL.
select_companySet the active company for future tool calls.
get_app_urlsBuild dashboard URLs for campaigns, landing pages, sequences, emails, settings, domains, and sent email details.
create_companyCreate a new company or brand.
get_companyRead company details, product info, brand context, localization, reply-tracking settings, and current From/Reply-To defaults; STO is explicitly identified as campaign-only.
update_companyEdit product info, brand context, email theme, reply tracking, and account-wide From/Reply-To profile defaults or names.
get_sync_rulesRead the company's event-to-tag rules and whether it uses the inherited platform preset.
update_sync_rulesReplace all sync rules; pass [] to disable them or null to opt into the SaaS/ecommerce platform preset.
get_shopify_automation_settingsRead browse-abandonment, cart-abandonment, and price-drop settings for the connected Shopify store.
update_shopify_automation_settingsPartially update Shopify automation settings or reset an individual section to its platform defaults.
create_api_keyCreate an API key for a company, with optional permission preset or explicit scopes.
request_api_key_handoffPrepare an owner-reviewed create/rotation URL when the active key cannot manage API keys itself.
list_api_keysList company API keys as non-secret metadata for safe identification and cleanup.
update_api_keyRename a company API key or replace its permission preset or scopes without changing the key value.
revoke_api_keyPermanently revoke an exact company API key by ID after checking it with list_api_keys.
delete_api_keyCompatibility alias for revoke_api_key.
list_websitesList sending domains with stored aggregate, SPF, DKIM, and MAIL FROM status.
add_sending_domainAdd a sending domain and return its cohort-specific DNS setup records.
add_websiteCompatibility alias for add_sending_domain.
check_websiteRead a sending domain's stored SPF, DKIM, MAIL FROM, and aggregate verification details.
verify_sending_domainRun a fresh sending-domain DNS/provider verification and return current status and diagnostics.
list_integrationsList connected integrations with connection and sync health, without returning credentials.
get_sending_statusDiagnose active, paused, or suspended sending, including enforcement denominators, review gates, and remediation steps.
resume_sendingRestore an eligible hard-bounce pause after explicitly confirming the list has been sanitized.
get_tracking_settingsRead open, click, unsubscribe, attribution, UTM, click-domain, reply-tracking, and double-opt-in settings.
update_tracking_settingsUpdate email tracking, attribution, UTM, and account-wide double-opt-in defaults.
get_integration_guideGet framework-specific integration examples.
get_integrationInspect one connected integration, its event wiring, list targeting, recent activity, and recommendations.
list_integration_capabilitiesCompare provider capabilities whether or not they are connected.
connect_integrationConnect supported API-key or webhook-secret providers, including Segment and optional PostHog/Segment history import.
get_event_schemaInspect published event payload examples, property paths, types, and merge tags by provider.
list_integration_activityRead the retained integration-specific webhook and sync activity log.
set_integration_sync_enabledEnable or disable bulk imports and backfills while leaving live webhooks connected.
set_integration_list_targetingChoose which lists contacts created by a supported integration join on future provider writes.
sync_integrationQueue payment revenue, Supabase users, or a PostHog/Segment event-history import using the saved integration configuration.
get_integration_pixelRead Shopify's live pixel/configuration state and distinguish confirmed dark events from an unknown read.
activate_integration_pixelInstall or repoint Shopify's storefront pixel; idempotent when it is already current.
list_web_tracking_keysList publishable website-tracking keys, origin restrictions, usage state, and install snippets.
get_web_tracking_keyGet one website-tracking key with its exact install snippet and ingest endpoint.
create_web_tracking_keyCreate a publishable tracking key for a non-Shopify storefront or website.
update_web_tracking_keyRename, restrict, revoke, or re-enable a website-tracking key.
delete_web_tracking_keyPermanently delete a website-tracking key after its snippet has been removed.
list_sender_profilesList sender and reply-to profiles, defaults, and sending-domain readiness.
update_sender_profileRename one sender or reply-to profile without changing the account defaults.
get_notification_preferencesRead the current user's per-company account notification settings and supported modes.
update_notification_preferencesUpdate the current user's account notification delivery modes without affecting teammates.
render_emailRender final email-safe HTML and diagnose unresolved merge tags, including typos hidden by defaults.

get_sending_status keeps the Postgres-backed pause state, review gates, and remediation available when sender-health analytics are temporarily unavailable; in that degraded case senderHealth is null.

render_email returns unresolvedMergeTags so callers can distinguish an unknown name from a recognized tag that is merely blank for the previewed contact. Unknown names are reported even when a default filter supplied text: for example, {{ subscriber.frstName | default: "there" }} renders a plausible greeting for every contact while bypassing stored first names. A recognized name that is blank for one contact is not reported when its default is used.

To render a sequence step whose nodeType is action_ab_test, pass the step's sequenceId and nodeId together with a variantId from get_sequence.sequence.emails[].abTest.variants. These steps have no email of their own, so the variant is required; reading and rendering their competing copy also requires the ab_tests:read scope.

For Supabase, sync_integration reuses the project, schema, table, list selection, and consent mappings saved in the dashboard. It cannot target an arbitrary table. Run it after installing the live database trigger to import users who existed before the trigger was installed, then poll get_integration and list_integration_activity for progress and row-level outcomes.

set_integration_sync_enabled controls bulk imports and backfills only; it does not stop a provider's live webhook from creating contacts. Use set_integration_list_targeting to choose their future list memberships: null follows workspace defaults, [] joins no list, and a populated array targets those lists. The change is not retroactive and never removes existing memberships. It also does not stop default any_contact sequences, which enroll list-less contacts; explicit any_list and specific-list sequences require a matching membership. Pair list targeting with pause_sequence_enrollments when those default enrollments must stop too. Supabase, Stripe, Shopify, Wix, and Webflow support this control.

For PostHog, sync_integration restarts the event-history import from the beginning with the stored personal API key. Imported events are deduplicated, so retrying a failed import does not create duplicates.

For Segment, connect_integration can optionally import recent event history from Unify after the live webhook is connected. The import walks existing contacts through the Profile API, covers the API's most recent 14 days, skips contacts without a matching profile, and safely deduplicates retries and live webhook overlap. New connections skip automatic page/screen calls unless those names are explicitly allowlisted. Segment webhook secrets must be 16-153 UTF-8 bytes. Use sync_integration to retry with the saved credentials.

Call get_event_schema before writing an {{event.*}} merge tag or an event property filter. Omit eventName to list documented built-in events; provide an event name to receive provider-specific example payloads and property paths, and optionally filter by provider. Custom event names remain valid even when the result reports documented: false; that only means no reference sample is published. Use integration activity or sequence enrollments for actual delivery data because this tool returns static reference data.

For a new sending domain, call add_sending_domain, publish the DNS records in the returned website.dnsRecords, wait for DNS propagation, and then call verify_sending_domain. Publish every returned record instead of assuming a fixed provider or record count: unified domains include required DMARC, while legacy domains can return Amazon SES MAIL FROM and inbound-reply records. If verification is attempted before creation, the error points back to add_sending_domain with the requested domain.

For Shopify, call get_integration_pixel before relying on product views, cart activity, or browse-abandonment triggers. The result is read live from Shopify because merchants can remove the pixel independently. If pixel.healthy is false, dependentEvents names the triggers that cannot arrive; call activate_integration_pixel to install or repoint the pixel. Activation is idempotent, and events begin on the next storefront visit rather than being backfilled.

For custom, headless, ticketing, or SaaS websites, use list_web_tracking_keys before relying on product-view or cart triggers. Create a key with an explicit origin allowlist, install the returned installSnippet, then have the customer's authenticated backend mint a short-lived proof through POST /api/v1/web-tracking-identities and call sequenzy.identify(email, identityToken) at sign-in or checkout. A publishable key alone only records anonymous activity and cannot trigger subscriber automation. The returned snippet installs synchronous method stubs before its async loader, so identity and event calls made during page bootstrap are queued until the SDK is ready. Prefer revoking a key with update_web_tracking_key before permanently deleting it.

New companies start with no sync rules. The inherited preset remains available for SaaS/ecommerce companies by passing null to update_sync_rules; services and consulting companies should normally keep [] or define explicit rules.

Use list_sender_profiles to find the profile ID, then call update_sender_profile to change only its display name. Pass type: "reply" for a reply-to profile; sender is the default. The address, sending domain, and account-wide default From/Reply-To selections remain unchanged. Renaming requires the companies:manage scope.

Shopify cart abandonment is enabled by default. It fires ecommerce.cart_abandoned after one hour of cart inactivity, with a 24-hour per-subscriber cooldown. Use update_shopify_automation_settings to change the cartAbandonment.enabled, delayHours, or cooldownHours fields; pass cartAbandonment: null to restore those defaults without changing browse abandonment or price-drop settings. Timing values must be positive; delayHours is capped at 168 and cooldownHours at 720.

Subscribers

ToolDescription
add_subscriberAdd one subscriber; status is creation-only, so use update_subscriber for an existing contact.
create_subscriber_importQueue up to 5,000 full CRM records with an optional retry-safe idempotencyKey; enabled email-hygiene checks continue separately after ingestion.
get_subscriber_importRead progress, row outcome counts, and failure summaries for a queued import.
update_subscriberUpdate native profile and phone fields, SMS consent, attributes, tags, or global status.
remove_subscriberUnsubscribe while preserving suppression history, or permanently delete only with hardDelete: true.
get_subscriberFetch subscriber details by email or external ID.
search_subscribersSearch by query, tags, list, status, segment, or one custom attribute, with automatic or resumable pagination.
trigger_subscriber_eventEmit one custom event exactly as an integration would, applying sync rules and matching sequence triggers.
trigger_subscriber_eventsEmit several ordered custom events for one subscriber.
import_subscriber_eventsImport up to 25 source-identified events across contacts; silent history requires every row for a contact to be over an hour old.
bulk_add_subscriber_tagsAdd tags to up to 500 existing subscribers; requires subscribers:tag and may also require tags:write.
bulk_remove_subscriber_tagsRemove tags from up to 500 existing subscribers; requires subscribers:tag or subscribers:write.

Use create_subscriber_import for CRM onboarding instead of looping over add_subscriber. One call accepts 5,000 full records and returns an asynchronous import ID; poll it with get_subscriber_import. A completed import can still contain row failures, so inspect failedCount and failedReasons. Every excluded row is accounted for: skippedReasons sums to skippedCount, and failedReasons sums to failedCount. Report any shortfall with the import ID instead of guessing which rows were omitted. When email hygiene is enabled, deliverability checks continue separately after ingestion and results appear in List health; import status does not wait for or include those verdicts. Invalid verdicts are suppressed from later sends. Use optInMode: "confirmed" only when consent was already verified.

For import_subscriber_events, email is required when a row may create a new contact; externalId can stand alone only for an existing contact. Supply a stable eventId on every row. Retrying reuses the original receipt and idempotently re-attempts downstream recovery. Historical classification is per contact: if any row for a contact is recent, that contact's whole group uses the live side-effect path.

For compliance suppression, call update_subscriber with status: "unsubscribed" (or use remove_subscriber without hardDelete). Do not retry add_subscriber with a different status: status on that tool applies only when the contact is first created, and a mismatched skipped result is reported as an error.

When add_subscriber omits listIds, a contact created by the call follows the workspace default lists while an existing contact keeps its current list memberships. Pass list IDs explicitly when an existing contact should join specific lists; pass [] to target no lists.

update_subscriber.phone writes the native phone field shown on the contact, not a custom attribute. Pass smsConsent: true only after verifying express written consent, or false to opt the contact out. Changing the phone without smsConsent resets SMS consent because consent belongs to the old number.

add_subscriber, update_subscriber, and create_subscriber_import accept an IANA timezone such as America/New_York. The value is stored on the native contact profile and enables recipient-local campaign delivery. Pass an empty timezone to update_subscriber to clear it; invalid import-row values are ignored without rejecting the rest of the import.

Products & Digital Delivery

ToolDescription
list_productsList synced products from Stripe, Shopify, WooCommerce, manual, or Commerce API data.
upsert_productsCreate or update up to 100 Commerce API products keyed by your product ID.
delete_productDelete a product previously pushed through the Commerce API.
attach_product_fileAttach a hosted or locally uploaded delivery file to a product.
remove_product_fileRemove an attached product delivery file.
sync_productsQueue a Stripe product catalog sync, optionally selecting an integration by ID.

After a product delivery file is attached, matching purchase events include download.url and download.name, so purchase-triggered emails can use merge tags like {{event.download.url}}.

For Stripe products, list_products returns every active price as a variant, with the Stripe price ID in variantId. Use that ID to target an exact price in a purchase sequence even when it is not the product's default price.

Image Assets

ToolDescription
upload_image_assetUpload an email image and return its hosted media record plus a ready-to-insert image block.

The tool accepts PNG, JPEG, GIF, and WebP images up to 5MB. Local stdio clients can pass filePath. Hosted/remote clients that can access attachment bytes can pass imageBase64 with filename. Provide altText for accessibility, then use displayWidthPercent, cropHeight, objectFit (cover or contain), and align to standardize screenshot presentation. The returned imageBlock can be copied directly into the block array accepted by campaign, sequence, template, and transactional-email tools.

Authenticated image bytes are always uploaded to the origin configured by SEQUENZY_API_URL, even if a reverse proxy returns an equivalent upload URL under another host. API credentials are never forwarded to that alternate origin.

{
  "filePath": "/Users/me/Desktop/product-results.png",
  "altText": "Product results dashboard",
  "displayWidthPercent": 100,
  "cropHeight": 320,
  "objectFit": "cover",
  "align": "center"
}

Lists, Tags, Segments

ToolDescription
list_tagsList all tags.
create_tagCreate a tag definition with an optional color.
update_tagUpdate a tag color.
delete_tagDelete a tag and remove it from subscribers.
list_listsList subscriber lists.
create_listCreate a subscriber list.
update_listRename or describe a subscriber list.
delete_listDelete a subscriber list.
add_subscribers_to_listAdd up to 500 subscribers to a list from an email array.
remove_subscribers_from_listRemove up to 500 subscribers from a list.
list_segmentsList saved segments and counts.
create_segmentCreate saved segments from filters or nested AND/OR groups.
update_segmentUpdate segment name, filters, root group, or join operator.
delete_segmentDelete a saved segment.
get_segment_countPreview the active subscriber count for a segment.

For subscriber exports, search_subscribers accepts listId, exact listName, or list (ID first, then exact name). It also accepts attribute plus attributeValue, with attributeOperator for contains, numeric comparisons, or is_not_empty; the combined "attributeName:value" form remains supported. Filters combine with AND; use a saved segment for OR logic, nested groups, exclusions, engagement, or event conditions. If limit is omitted, the tool fetches every matching page automatically. For chunked reads, pass limit and follow pagination.nextCursor (or pagination.nextOffset) while hasMore is true. offset and page are supported below 1,000,000 skipped matches; use the cursor for deeper audiences.

For bulk list population, use add_subscribers_to_list; the backing API endpoint is POST /api/v1/lists/{listId}/subscribers with no /bulk suffix:

{
  "emails": ["ada@example.com", "grace@example.com"],
  "duplicateStrategy": "skip",
  "enrollInSequences": false,
  "optInMode": "default"
}

Send at most 500 emails per request. Standard API rate limits still apply: 100 requests per minute per API key and 20 requests per second burst. For CSV-driven CLI imports, accepted email headers include email, e-mail, email address, and mail; if no recognized header exists, the CLI reads the first column.

Segment filters support attributes, events, saved segment membership, engagement events, Stripe product purchase rules, and commerce product purchase rules. Use filterJoinOperator: "or" for match-any segments, or pass a v2 root group for nested logic.

Each segment filter field validates its own operators:

  • status, segment: is, is_not
  • tag: contains, not_contains, is_empty, is_not_empty
  • email: contains, not_contains
  • emailProvider, list: is, is_not, is_empty, is_not_empty
  • firstName, lastName: contains, not_contains, is_empty, is_not_empty
  • added: less_than, more_than
  • attribute: is, is_not, is_empty, is_not_empty, gte, lte, gt, lt, contains, not_contains
  • event, email engagement fields: is, is_not, at_least, less_than_count
  • emailBounced: also supports is_temporary_bounce, is_permanent_bounce
  • stripeProduct: is, is_not, at_least, less_than_count
  • stripeCurrentProduct, stripeTrialProduct: is, is_not, gte, lte, gt, lt
  • commerceProduct: is, is_not, at_least, less_than_count

Stripe product filter examples:

Documentation truncated — see the full README on GitHub.

Reviews

No reviews yet

Be the first to review this server!