Sequenzy

https://docs.sequenzy.com
Admin
Sequenzy is a modern email marketing platform that enables developers to build campaigns, automate...
Tokens:220,458
Snippets:2,129
Trust Score:7.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Fetch Integration Guide via cURL

Source: https://docs.sequenzy.com/api-reference/account/integration-guide

Retrieve a framework-specific integration example by sending a POST request with the framework and use case keys.

```bash
curl -X POST "https://api.sequenzy.com/api/v1/integration-guide" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"framework": "nextjs", "use_case": "transactional"}'
```

--------------------------------

### Install Sequenzy and Express

Source: https://docs.sequenzy.com/send-email/express

Use these commands to install the necessary dependencies for your project.

```bash
npm install sequenzy express
```

```bash
pnpm add sequenzy express
```

```bash
bun add sequenzy express
```

--------------------------------

### New Customer Onboarding Example

Source: https://docs.sequenzy.com/api-reference/subscribers/tags/add-bulk

Example of adding tags along with custom attributes for a new customer.

```bash
# Tag with multiple attributes at once
curl -X POST "https://api.sequenzy.com/api/v1/subscribers/tags/bulk" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "new-customer@example.com",
    "tags": ["customer", "onboarding", "2024-cohort", "source-organic"],
    "customAttributes": {
      "plan": "pro",
      "signupDate": "2024-01-15"
    }
  }'
```

--------------------------------

### Trigger Subscription Lifecycle Events

Source: https://docs.sequenzy.com/api-reference/subscribers/events/trigger

Examples for tracking trial starts, payment failures, and churn events.

```bash
# Trial started
curl -X POST "https://api.sequenzy.com/api/v1/subscribers/events" \
  -d '{ "email": "user@example.com", "event": "saas.trial_started" }'

# Payment failed
curl -X POST "https://api.sequenzy.com/api/v1/subscribers/events" \
  -d '{
    "email": "user@example.com",
    "event": "saas.payment_failed",
    "properties": { "attemptCount": 2 }
  }'

# Customer churned
curl -X POST "https://api.sequenzy.com/api/v1/subscribers/events" \
  -d '{ "email": "user@example.com", "event": "saas.churn" }'
```

--------------------------------

### Install and run the Sequenzy CLI

Source: https://docs.sequenzy.com/concepts/cli

Use npx or bunx for one-off execution, or install globally via npm.

```bash
# Using npx (no install needed)
npx @sequenzy/cli --help

# Using Bun (no install needed)
bunx @sequenzy/cli --help

# Or install globally
npm install -g @sequenzy/cli
```

--------------------------------

### UTM Tagging Transformation Example

Source: https://docs.sequenzy.com/concepts/utm-tracking

Demonstrates how a starting URL is transformed into a rendered link with UTM parameters applied.

```text
https://app.example.com/pricing?plan=pro
```

```text
utm_source=sequenzy
utm_medium=email
utm_campaign={{email.subject}}
utm_content={{link.text}}
```

```text
https://app.example.com/pricing?plan=pro&utm_source=sequenzy&utm_medium=email&utm_campaign=Launch+Week&utm_content=Start+trial
```

--------------------------------

### Install Sequenzy SDK and React Email

Source: https://docs.sequenzy.com/send-email/nextjs

Install the required packages using your preferred package manager.

```bash
npm install sequenzy @react-email/components @react-email/render
```

```bash
pnpm add sequenzy @react-email/components @react-email/render
```

```bash
bun add sequenzy @react-email/components @react-email/render
```

--------------------------------

### Install Sequenzy Better Auth Plugin

Source: https://docs.sequenzy.com/integrations/better-auth

Install the required package using your preferred package manager.

```bash
npm install @sequenzy/better-auth
# or
bun add @sequenzy/better-auth
# or
pnpm add @sequenzy/better-auth
```

--------------------------------

### Install Sequenzy SDK

Source: https://docs.sequenzy.com/api-reference/introduction

Commands to install the official Sequenzy SDK using common package managers.

```bash
npm install sequenzy
# or
pnpm add sequenzy
# or
bun add sequenzy
```

--------------------------------

### Integration Guide API Responses

Source: https://docs.sequenzy.com/api-reference/account/integration-guide

Example JSON responses for successful requests and unauthorized access attempts.

```json
{
  "success": true,
  "framework": "nextjs",
  "use_case": "transactional",
  "code": "await fetch('https://api.sequenzy.com/api/v1/transactional/send', ...)",
  "tip": "For transactional emails, make sure to set up a verified sending domain in the dashboard for best deliverability."
}
```

```json
{
  "success": false,
  "error": "Unauthorized"
}
```

--------------------------------

### Tag Normalization Examples

Source: https://docs.sequenzy.com/concepts/tags

Examples showing how input strings are transformed into normalized tag formats.

```text
"Pro Customer" → "pro-customer"
"VIP_User"     → "vip-user"
"Newsletter!"  → "newsletter"
```

--------------------------------

### Install React Email Dependencies

Source: https://docs.sequenzy.com/send-email/bun

Install the required packages for rendering React components as email HTML.

```bash
bun add @react-email/components @react-email/render
```

--------------------------------

### Run Bun Server

Source: https://docs.sequenzy.com/send-email/bun

Start the Bun server to begin listening for requests.

```bash
bun run index.tsx
```

--------------------------------

### Custom UTM Template Example

Source: https://docs.sequenzy.com/concepts/utm-tracking

An example of a custom template mixing static text and template variables.

```text
utm_source={{company.name}}
utm_medium=email
utm_campaign={{email.subject}}
utm_content={{link.text}}
```

--------------------------------

### Run Express Server

Source: https://docs.sequenzy.com/send-email/express

Command to start the development server using tsx.

```bash
npx tsx index.ts
```

--------------------------------

### Run the Sequenzy setup wizard

Source: https://docs.sequenzy.com/concepts/mcp

Use the interactive CLI wizard to automatically detect and configure supported AI clients.

```bash
npx @sequenzy/setup
```

--------------------------------

### Campaign API Response Examples

Source: https://docs.sequenzy.com/api-reference/campaigns/get

These JSON objects represent the possible outcomes of the GET request, including success and error states.

```json
{
    "success": true,
    "campaign": {
      "id": "camp_abc123",
      "name": "April Launch",
      "subject": "A quick update",
      "preheader": "Latest product news",
      "preheaderText": "Latest product news",
      "status": "draft",
      "labels": ["edm", "launch"],
      "blocks": [],
      "campaignData": null,
      "computedLists": [],
      "replyProfileId": "reply_abc123",
      "replyToName": "Support",
      "replyToEmail": "support@example.com",
      "scheduledAt": null,
      "sentAt": null,
      "createdAt": "2026-05-01T10:30:00Z",
      "url": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123",
      "previewUrl": "https://sequenzy.com/dashboard/company/comp_abc123/campaign/camp_abc123?step=review"
    }
  }
```

```json
{
    "success": false,
    "error": "Unauthorized"
  }
```

```json
{
    "success": false,
    "error": "Campaign not found"
  }
```

--------------------------------

### POST /api/v1/integration-guide

Source: https://docs.sequenzy.com/api-reference/account/integration-guide

Retrieves a framework-specific code example and implementation tip based on the provided framework and use case.

```APIDOC
## POST /api/v1/integration-guide

### Description
Retrieves a framework-specific code example and implementation tip for a given use case.

### Method
POST

### Endpoint
https://api.sequenzy.com/api/v1/integration-guide

### Parameters
#### Request Body
- **framework** (string) - Optional - Framework key. Defaults to `nextjs`.
- **use_case** (string) - Optional - Use case key: `transactional`, `subscribe_form`, `event_tracking`, or `ecommerce`. Defaults to `transactional`.

### Request Example
{
  "framework": "nextjs",
  "use_case": "transactional"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **framework** (string) - The framework used.
- **use_case** (string) - The use case requested.
- **code** (string) - The integration code snippet.
- **tip** (string) - Implementation tip for the selected use case.

#### Response Example
{
  "success": true,
  "framework": "nextjs",
  "use_case": "transactional",
  "code": "await fetch('https://api.sequenzy.com/api/v1/transactional/send', ...)",
  "tip": "For transactional emails, make sure to set up a verified sending domain in the dashboard for best deliverability."
}
```

--------------------------------

### Website API Response Examples

Source: https://docs.sequenzy.com/api-reference/websites/get

These JSON objects represent the possible outcomes of the GET request, including success, unauthorized access, and domain not found errors.

```json
{
  "success": true,
  "website": {
    "domain": "mail.example.com",
    "status": "pending",
    "dnsRecords": {},
    "createdAt": "2026-05-01T10:30:00Z"
  }
}
```

```json
{
  "success": false,
  "error": "Unauthorized"
}
```

```json
{
  "success": false,
  "error": "Domain not found"
}
```

--------------------------------

### Webflow Marketplace Install URL

Source: https://docs.sequenzy.com/integrations/webflow

The URL used for initiating the Marketplace app installation.

```text
https://www.sequenzy.com/integrations/webflow/install
```

--------------------------------

### Set up email sequences for a SaaS

Source: https://docs.sequenzy.com/concepts/mcp

Demonstrates the use of list_sequences, generate_sequence, and create_sequence to initialize a multi-email onboarding flow.

```text
You: "Set up email sequences for my SaaS that has a 14-day trial"

Claude: I'll help set that up. First, let me check your current sequences...
[Uses list_sequences]

You don't have any sequences yet. I'll create three for you:
1. Welcome sequence (triggered on signup)
2. Trial nurture (days 1, 3, 7, 10, 13)
3. Trial ending reminder (day 12)

[Uses generate_sequence and create_sequence for each]

Done! I've created 3 sequences with 8 emails total.
```

--------------------------------

### Start Migration Request

Source: https://docs.sequenzy.com/api-reference/migrations/start

Executes a POST request to queue a migration run with optional resource IDs and configuration.

```bash
curl -X POST "https://api.sequenzy.com/api/v1/migrations/run_123/start" \
  -H "Authorization: Bearer SEQUENZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"resourceIds":["subscribers","tags","custom_fields","automations"],"resourceOptions":{"automations":{"names":["Budget Worksheet"]}}}'
```

--------------------------------

### Conversation API Response Examples

Source: https://docs.sequenzy.com/api-reference/conversations/get

These examples represent the structure of successful and error responses from the API.

```json
{
    "success": true,
    "conversation": {
      "id": "conv_abc123",
      "companyId": "comp_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "user@example.com",
      "subscriberName": "John Doe",
      "subject": "Re: A quick update",
      "status": "open",
      "messageCount": 2,
      "lastMessageAt": "2026-06-11T09:30:00.000Z",
      "lastMessageBy": "subscriber",
      "hasUnread": true,
      "initialEmailSendId": "send_abc123",
      "initialCampaignId": "camp_abc123",
      "initialAutomationNodeId": null,
      "createdAt": "2026-06-10T15:00:00.000Z",
      "updatedAt": "2026-06-11T09:30:00.000Z",
      "expiresAt": null,
      "messages": [
        {
          "id": "msg_abc123",
          "type": "inbound",
          "subject": "Re: A quick update",
          "bodyText": "Thanks, this is great!",
          "bodyHtml": null,
          "fromEmail": "user@example.com",
          "fromName": "John Doe",
          "fromUserId": null,
          "attachments": [],
          "isRead": false,
          "readAt": null,
          "readBy": null,
          "deliveryStatus": null,
          "deliveredAt": null,
          "createdAt": "2026-06-11T09:30:00.000Z"
        }
      ],
      "context": {
        "type": "campaign",
        "campaignId": "camp_abc123",
        "campaignName": "April Launch",
        "automationNodeId": null,
        "automationName": null,
        "initialEmailSubject": "A quick update"
      },
      "subscriber": {
        "id": "sub_abc123",
        "email": "user@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "tags": ["premium"],
        "customAttributes": { "plan": "pro" }
      }
    }
  }
```

```json
{
    "success": false,
    "error": "Unauthorized"
  }
```

```json
{
    "error": "Conversation not found"
  }
```

--------------------------------

### Onboarding Automation Logic

Source: https://docs.sequenzy.com/integrations/posthog

A visual representation of an onboarding sequence triggered by product usage events.

```text
Trigger: product.signup_completed
├── Wait 1 day
├── Check: product.first_project_created received?
│   ├── Yes → Send "Great start!" email
│   └── No → Send "Need help getting started?" email
```

--------------------------------

### Run local development services

Source: https://docs.sequenzy.com/integrations/webflow

Commands to start the frontend, API, and worker services, and expose them via ngrok for webhook testing.

```bash
bun --filter @emailer/front dev
bun --filter @emailer/api dev
bun --filter @emailer/workers dev
ngrok http --url=YOUR_APP_NGROK_DOMAIN 3000
ngrok http --url=YOUR_API_NGROK_DOMAIN 4000
```

--------------------------------

### Initialize Popup Widget

Source: https://docs.sequenzy.com/api-reference/widgets/popup-runtime

Configure the popup widget by setting window.SequenzyPopupConfig and loading the runtime script.

```html
<script>
  window.SequenzyPopupConfig = {
    companyId: "company_123",
    apiBaseUrl: "https://api.sequenzy.com",
    listMode: "all",
    listIds: [],
    tagIds: [],
    templateId: "newsletter",
    layout: "fullscreen",
    trigger: { type: "delay", delaySeconds: 5 },
    content: {
      title: "Join the newsletter",
      description: "Get practical updates delivered to your inbox.",
      buttonText: "Subscribe",
      successMessage: "Thanks for subscribing.",
      badgeText: "Newsletter",
    },
    visual: { style: "accent", placement: "top" },
    fields: { email: { placeholder: "you@example.com" } },
    theme: {
      accentColor: "#f97316",
      backgroundColor: "#ffffff",
      textColor: "#111827",
    },
  };
</script>
<script async src="https://api.sequenzy.com/api/v1/widgets/popup.js"></script>
```

--------------------------------

### Event Payload Example

Source: https://docs.sequenzy.com/api-reference/sequences/create

Example of an event payload used to populate merge tags in sequence emails.

```json
{
  "email": "user@example.com",
  "event": "weather.wind_alert",
  "properties": {
    "city": "Tel Aviv",
    "alert": {
      "maxSpeed": 75
    },
    "duration": {
      "hours": 6
    }
  }
}
```

--------------------------------

### Manage Landing Pages via CLI

Source: https://docs.sequenzy.com/concepts/landing-pages

Commands for creating, publishing, and connecting domains to landing pages using the Sequenzy CLI.

```bash
sequenzy landing-pages create "Product Waitlist" --template waitlist
sequenzy landing-pages publish lp_abc123
sequenzy landing-pages connect-domain pages.example.com
```

--------------------------------

### Scripting with Sequenzy CLI

Source: https://docs.sequenzy.com/concepts/cli

Example of importing subscribers and verifying authentication status within a bash script.

```bash
#!/bin/bash

# Import subscribers from CSV into a list
sequenzy lists import list_123 --emails-file subscribers.csv

# Check if logged in
if ! sequenzy whoami > /dev/null 2>&1; then
  echo "Not logged in"
  exit 1
fi
```

--------------------------------

### Run Local Wix Development Environment

Source: https://docs.sequenzy.com/integrations/wix

Commands to start the local development stack and expose the environment via ngrok for Wix testing.

```bash
bun run dev
bun run dev:api
bun run dev:workers
bun scripts/wix/local-wix-proxy.ts
ngrok http --url=YOUR_NGROK_DOMAIN 8787
```

--------------------------------

### Ad Accounts API Response Examples

Source: https://docs.sequenzy.com/api-reference/audience-syncs/ad-accounts

These examples show the structure of successful and error responses from the ad accounts endpoint.

```json
{
    "success": true,
    "adAccounts": [
      {
        "id": "act_1234567890",
        "name": "Acme Main Account"
      }
    ]
  }
```

```json
{
    "error": "Meta Ads is not connected for this company. Connect it in Settings -> Integrations."
  }
```

```json
{
    "error": "Unauthorized"
  }
```

--------------------------------

### Embed Subscription Preferences Widget

Source: https://docs.sequenzy.com/widgets/subscription-preferences

Implementation examples for rendering the Sequenzy preferences iframe across different frontend frameworks. Each example includes token fetching and message event handling for dynamic iframe resizing.

```tsx
"use client";

import { useState, useEffect } from "react";

export function EmailPreferences() {
  const [token, setToken] = useState<string | null>(null);
  const [loading, setLoading] = useState(true);

  useEffect(() => {
    async function fetchToken() {
      const res = await fetch("/api/preferences-token", { method: "POST" });
      const data = await res.json();
      setToken(data.token);
      setLoading(false);
    }
    fetchToken();
  }, []);

  useEffect(() => {
    // Handle iframe resize messages
    const handleMessage = (e: MessageEvent) => {
      if (e.data.type === "sequenzy-preferences-resize") {
        const iframe = document.getElementById(
          "sequenzy-preferences"
        ) as HTMLIFrameElement;
        if (iframe) iframe.style.height = e.data.height + "px";
      }
    };
    window.addEventListener("message", handleMessage);
    return () => window.removeEventListener("message", handleMessage);
  }, []);

  if (loading) return <div>Loading preferences...</div>;
  if (!token) return <div>Unable to load preferences</div>;

  return (
    <iframe
      id="sequenzy-preferences"
      src={`https://sequenzy.com/embed/preferences?token=${token}`}
      width="100%"
      height="400"
      frameBorder="0"
      style={{ border: "none", maxWidth: "500px" }}
    />
  );
}
```

```html
<div id="preferences-container">
  <div id="preferences-loading">Loading preferences...</div>
</div>

<script>
  async function loadPreferences() {
    const container = document.getElementById("preferences-container");
    const loading = document.getElementById("preferences-loading");

    try {
      const res = await fetch("/api/preferences-token", { method: "POST" });
      const data = await res.json();

      loading.remove();

      const iframe = document.createElement("iframe");
      iframe.id = "sequenzy-preferences";
      iframe.src = `https://sequenzy.com/embed/preferences?token=${data.token}`;
      iframe.width = "100%";
      iframe.height = "400";
      iframe.frameBorder = "0";
      iframe.style.border = "none";
      iframe.style.maxWidth = "500px";

      container.appendChild(iframe);
    } catch (error) {
      loading.textContent = "Unable to load preferences";
    }
  }

  // Handle auto-resize
  window.addEventListener("message", function (e) {
    if (e.data.type === "sequenzy-preferences-resize") {
      const iframe = document.getElementById("sequenzy-preferences");
      if (iframe) iframe.style.height = e.data.height + "px";
    }
  });

  loadPreferences();
</script>
```

```vue
<template>
  <div v-if="loading">Loading preferences...</div>
  <div v-else-if="error">Unable to load preferences</div>
  <iframe
    v-else
    id="sequenzy-preferences"
    :src="`https://sequenzy.com/embed/preferences?token=${token}`"
    width="100%"
    :style="{ height: iframeHeight + 'px', border: 'none', maxWidth: '500px' }"
    frameborder="0"
  />
</template>

<script setup>
import { ref, onMounted, onUnmounted } from "vue";

const token = ref(null);
const loading = ref(true);
const error = ref(false);
const iframeHeight = ref(400);

onMounted(async () => {
  try {
    const res = await fetch("/api/preferences-token", { method: "POST" });
    const data = await res.json();
    token.value = data.token;
  } catch (e) {
    error.value = true;
  } finally {
    loading.value = false;
  }

  window.addEventListener("message", handleResize);
});

onUnmounted(() => {
  window.removeEventListener("message", handleResize);
});

function handleResize(e) {
  if (e.data.type === "sequenzy-preferences-resize") {
    iframeHeight.value = e.data.height;
  }
}
</script>
```

--------------------------------

### get_ab_test_stats

Source: https://docs.sequenzy.com/concepts/mcp

Get aggregate and per-variant stats.

```APIDOC
## get_ab_test_stats

### Description
Get aggregate and per-variant stats.
```

--------------------------------

### Manage landing pages via CLI

Source: https://docs.sequenzy.com/concepts/cli

Commands for listing, creating, updating, publishing, and deleting landing pages, as well as managing custom domains.

```bash
# List landing pages
sequenzy landing-pages list
sequenzy landing-pages list --json

# Create a draft from a built-in template
sequenzy landing-pages create "Product Waitlist" --template waitlist
sequenzy landing-pages create "Launch Page" --template launch --slug launch

# Get or edit a page
sequenzy landing-pages get lp_abc123
sequenzy landing-pages update lp_abc123 --name "Updated Waitlist" --slug waitlist

# Publish or unpublish
sequenzy landing-pages publish lp_abc123
sequenzy landing-pages unpublish lp_abc123

# Connect or verify a custom landing page domain
sequenzy landing-pages connect-domain pages.example.com
sequenzy landing-pages update-domain-settings --verify

# Delete a page
sequenzy landing-pages delete lp_abc123
```

--------------------------------

### GET /v1/replies

Source: https://docs.sequenzy.com/concepts/reply-tracking

Retrieves a list of all replies.

```APIDOC
## GET /v1/replies

### Description
Retrieves a list of all replies.

### Method
GET

### Endpoint
https://api.sequenzy.com/v1/replies
```

--------------------------------

### get_ab_test

Source: https://docs.sequenzy.com/concepts/mcp

Get variants, content, and localization status.

```APIDOC
## get_ab_test

### Description
Get variants, content, and localization status.
```

--------------------------------

### Migration run response examples

Source: https://docs.sequenzy.com/api-reference/migrations/get

Standard JSON responses for successful requests and common error states.

```json
{"success":true,"data":{"id":"run_123","status":"awaiting_approval","discovery":{"provider":"kit","resources":[{"id":"subscribers","type":"subscribers","count":3470},{"id":"campaigns","type":"campaigns","count":108},{"id":"automations","type":"automations","count":42}]},"approvedPlan":{},"progress":{},"report":{"subscribersQueued":0,"draftCampaignsCreated":0,"draftSequencesCreated":0,"draftTransactionalEmailsCreated":0}}}
```

```json
{"error":"Missing API key. Provide via x-api-key header or Authorization: Bearer <key>"}
```

```json
{"error":"Access denied to the migration run"}
```

```json
{"error":"Migration run not found"}
```

--------------------------------

### Include opens and clicks for sequence email steps

Source: https://docs.sequenzy.com/api-reference/analytics/sequence-events

Retrieves delivery, open, and click events over a 30-day period.

```bash
curl "https://api.sequenzy.com/api/v1/metrics/sequences/seq_abc123/events?eventTypes=delivery,open,click&period=30d" \
 -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### GET /api/v1/subscribers/external

Source: https://docs.sequenzy.com/api-reference/subscribers/external

Retrieve a subscriber by their external ID.

```APIDOC
## GET /api/v1/subscribers/external

### Description
Retrieve a subscriber record using a customer-owned external ID.

### Method
GET

### Endpoint
/api/v1/subscribers/external

### Parameters
#### Query Parameters
- **externalId** (string) - Required - Customer-owned external ID.
- **includeMachineEngagement** (boolean) - Optional - Set to true to include detected scanner, preview, and tracked asset open/click events.
```

--------------------------------

### Sync Rule Complexity Management

Source: https://docs.sequenzy.com/concepts/sync-rules

Guidance on maintaining simplicity by starting with default rules before adding custom logic.

```text
✓ Start simple
  - Use default SaaS events
  - Add custom rules for specific needs

✗ Over-engineer
  - Custom rule for every possible event
  - Complex tag dependencies
```

--------------------------------

### GET /api/v1/subscribers

Source: https://docs.sequenzy.com/api-reference/introduction

Retrieves a paginated list of subscribers.

```APIDOC
## GET /api/v1/subscribers

### Description
Retrieves a list of subscribers with support for pagination.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/subscribers

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number (default: 1).
- **limit** (integer) - Optional - Items per page (default: 20, max: 100).

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - List of subscriber objects.
- **pagination** (object) - Pagination metadata including page, limit, total, and totalPages.
```

--------------------------------

### GET /api/v1/subscribers/{email}

Source: https://docs.sequenzy.com/api-reference/subscribers/get

Retrieve a subscriber by their email address.

```APIDOC
## GET /api/v1/subscribers/{email}

### Description
Retrieve a subscriber by their email address. The response includes the base subscriber profile plus internal notes, list memberships, sequence enrollments, email engagement stats, and the most recent activity events.

### Method
GET

### Endpoint
/api/v1/subscribers/{email}

### Parameters
#### Path Parameters
- **email** (string) - Required - Subscriber email (URL encoded)

#### Query Parameters
- **includeMachineEngagement** (boolean) - Optional - Set to true to include detected scanner, preview, and tracked asset open/click events in emailStats and recent activity.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **subscriber** (object) - The subscriber profile details

#### Response Example
{
  "success": true,
  "subscriber": {
    "id": "sub_abc123",
    "email": "user@sequenzy.com",
    "externalId": "user_123",
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "emailProvider": "gmail",
    "tags": ["customer", "newsletter"],
    "customAttributes": { "plan": "pro" },
    "notes": [],
    "lists": [],
    "sequenceEnrollments": [],
    "emailStats": { "sent": 12, "delivered": 12, "opened": 9, "clicked": 3, "bounced": 0, "unsubscribed": 0, "complained": 0 },
    "activity": [],
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}
```

--------------------------------

### Authenticate with Sequenzy

Source: https://docs.sequenzy.com/concepts/cli

Initiate the login flow to store an API key locally.

```bash
sequenzy login
```

--------------------------------

### sequenzy sequences get

Source: https://docs.sequenzy.com/concepts/cli

Retrieves detailed information for a specific sequence.

```APIDOC
## sequenzy sequences get [sequence_id]

### Description
Fetches the configuration and metadata for a specific sequence identified by its ID.
```

--------------------------------

### Template creation response examples

Source: https://docs.sequenzy.com/api-reference/templates/create

Standard JSON responses for successful creation and common error scenarios.

```json
{
    "success": true,
    "template": {
      "id": "email_abc123",
      "name": "[Template] Welcome",
      "subject": "Welcome!",
      "labels": ["edm"]
    }
  }
```

```json
{
    "success": false,
    "error": "Provide either html or blocks."
  }
```

```json
{
    "success": false,
    "error": "Unauthorized"
  }
```

```json
{
    "success": false,
    "error": "Failed to create template"
  }
```

--------------------------------

### Migration Source Response Examples

Source: https://docs.sequenzy.com/api-reference/migrations/connect-source

Standard response formats for successful connections and common error scenarios.

```json
{"success":true,"data":{"id":"run_123","status":"pending","provider":"mailchimp"}}
```

```json
{"success":false,"error":"Migration provider is not available"}
```

```json
{"error":"Invalid API key"}
```

```json
{"error":"Migration run not found"}
```

--------------------------------

### GET /api/v1/transactional

Source: https://docs.sequenzy.com/concepts/transactional-emails

Retrieves a list of all available transactional email templates.

```APIDOC
## GET /api/v1/transactional

### Description
Returns a list of all transactional email templates configured in the system.

### Method
GET

### Endpoint
/api/v1/transactional

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **transactional** (array) - List of template objects

#### Response Example
{
  "success": true,
  "transactional": [
    {
      "id": "trans_abc123",
      "slug": "order-confirmation",
      "name": "Order Confirmation",
      "emailId": "email_abc123",
      "enabled": true
    }
  ]
}
```

--------------------------------

### Install Sequenzy email marketing skill

Source: https://docs.sequenzy.com/concepts/skills

Use this command to add the Sequenzy email marketing skill to your AI agent environment.

```bash
npx skills add Sequenzy/skills --skill sequenzy-email-marketing
```

--------------------------------

### GET /v1/conversations/{id}

Source: https://docs.sequenzy.com/concepts/reply-tracking

Retrieves the details of a specific conversation by its ID.

```APIDOC
## GET /v1/conversations/{id}

### Description
Retrieves the details of a specific conversation by its ID.

### Method
GET

### Endpoint
https://api.sequenzy.com/v1/conversations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the conversation.
```

--------------------------------

### GET /api/v1/tags

Source: https://docs.sequenzy.com/api-reference/tags/list

Retrieves a list of tag definitions for the authenticated company.

```APIDOC
## GET /api/v1/tags

### Description
List tag definitions for the authenticated company.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/tags

### Request Example
curl "https://api.sequenzy.com/api/v1/tags" \
  -H "Authorization: Bearer YOUR_API_KEY"

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **tags** (array) - List of tag objects.
  - **id** (string) - Unique identifier for the tag.
  - **name** (string) - Name of the tag.
  - **color** (string) - Hex color code for the tag.
  - **isSystem** (boolean) - Whether the tag is a system-defined tag.

#### Response Example
{
  "success": true,
  "tags": [
    {
      "id": "tag_abc123",
      "name": "premium",
      "color": "#f97316",
      "isSystem": false
    }
  ]
}
```

--------------------------------

### GET /api/v1/subscribers/me

Source: https://docs.sequenzy.com/api-reference/subscribers/me

Retrieves account information for the authenticated API key.

```APIDOC
## GET /api/v1/subscribers/me

### Description
Returns account information for the authenticated API key. This endpoint is primarily used for connection labels (e.g., Zapier integrations).

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/subscribers/me

### Request Example
```bash
curl "https://api.sequenzy.com/api/v1/subscribers/me" \
  -H "x-api-key: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **account** (object) - Contains company details
  - **companyId** (string) - The unique identifier for the company
  - **companyName** (string) - The name of the company

#### Response Example
```json
{
  "success": true,
  "account": {
    "companyId": "company_abc123",
    "companyName": "Acme Inc"
  }
}
```
```

--------------------------------

### Define Signup Goals

Source: https://docs.sequenzy.com/concepts/goals

Use this configuration to track non-monetary milestones such as trial starts or account activations.

```text
Event: saas.trial_started
Revenue Property: (none)
Window: 7 days
```

--------------------------------

### GET /api/v1/sequences/{sequenceId}

Source: https://docs.sequenzy.com/api-reference/sequences/get

Retrieves a single sequence by its unique identifier.

```APIDOC
## GET /api/v1/sequences/{sequenceId}

### Description
Returns one sequence with its automation nodes and editable email steps.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/sequences/{sequenceId}

### Parameters
#### Path Parameters
- **sequenceId** (string) - Required - Sequence ID.

### Request Example
curl "https://api.sequenzy.com/api/v1/sequences/seq_abc123" \
  -H "Authorization: Bearer seq_live_xxx"

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **sequence** (object) - The sequence object containing metadata, nodes, and email steps.

#### Response Example
{
  "success": true,
  "sequence": {
    "id": "seq_abc123",
    "name": "Welcome Sequence",
    "status": "draft",
    "trigger": "trigger_list",
    "sendingWindow": {
      "enabled": true,
      "timezone": "Europe/Kiev",
      "startTime": "08:00",
      "endTime": "20:00",
      "days": ["monday", "tuesday", "wednesday", "thursday", "friday"]
    },
    "emails": [
      {
        "nodeId": "node_abc123",
        "emailId": "email_abc123",
        "stepNumber": 1,
        "name": "Welcome Sequence - Email 1",
        "subject": "Welcome to Acme",
        "previewText": null,
        "delayNodeId": null,
        "delayMode": null,
        "delayMs": null,
        "waitUntil": null,
        "delayDisplay": null,
        "delayDescription": null,
        "blocks": []
      }
    ],
    "createdAt": "2026-04-20T10:00:00.000Z",
    "enrichmentStatus": "complete",
    "emailCount": 1,
    "enrichedCount": 1
  }
}
```

--------------------------------

### GET /api/v1/segments

Source: https://docs.sequenzy.com/api-reference/segments/list

Retrieves a list of all saved segments for the authenticated company.

```APIDOC
## GET /api/v1/segments

### Description
List the saved segments in your company, including subscriber counts and filter definitions.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/segments

### Request Example
curl "https://api.sequenzy.com/api/v1/segments" \
  -H "Authorization: Bearer YOUR_API_KEY"

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **segments** (array) - A list of segment objects.

#### Response Example
{
  "success": true,
  "segments": [
    {
      "id": "seg_active_buyers",
      "name": "Active buyers",
      "filters": [
        {
          "id": "filter-1",
          "field": "tag",
          "operator": "contains",
          "value": "customer"
        }
      ],
      "filterJoinOperator": "and",
      "format": "v1",
      "createdAt": "2026-04-21T10:00:00.000Z",
      "subscriberCount": 1200,
      "activeSubscriberCount": 1180
    }
  ]
}
```

--------------------------------

### List and Retrieve Localization Data via CLI

Source: https://docs.sequenzy.com/concepts/email-localization

Use these commands to inspect company settings and template localization status from the command line.

```bash
sequenzy companies list
sequenzy companies get company_123
sequenzy templates list --company company_123
sequenzy templates get email_123 --company company_123 --json
```

--------------------------------

### Migrate a sequence from another platform

Source: https://docs.sequenzy.com/concepts/mcp

Demonstrates importing HTML content into a sequence using the create_sequence tool.

```text
You: "I have these React Email templates for my onboarding sequence.
Can you create a sequence that sends them?"

[Pastes HTML content]

Claude: [Uses create_sequence with steps using html field]
Done! I've created your onboarding sequence with the HTML content
you provided. The HTML was automatically converted to Sequenzy's
block format so you can edit it in the visual editor later.

The sequence is ready in draft mode with 3 emails.
```

--------------------------------

### GET /api/v1/products

Source: https://docs.sequenzy.com/api-reference/products/list

List products in your catalog with optional filtering and pagination.

```APIDOC
## GET /api/v1/products

### Description
List products in your catalog. Includes products synced from Shopify, WooCommerce, and Stripe, plus products pushed via the Commerce API.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/products

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of products to return (1-100). Defaults to 50.
- **offset** (integer) - Optional - Number of products to skip. Defaults to 0.
- **provider** (string) - Optional - Filter products by source: `api`, `stripe`, `shopify`, `woocommerce`, or `manual`.

### Request Example
curl "https://api.sequenzy.com/api/v1/products?provider=stripe&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **products** (array) - List of product objects.
- **pagination** (object) - Pagination metadata including limit, offset, and count.

#### Response Example
{
  "success": true,
  "products": [
    {
      "id": "prod_abc123",
      "productId": "SKU-PROTEIN-1KG",
      "provider": "api",
      "title": "Protein Powder",
      "priceCents": 8850,
      "currency": "USD",
      "inStock": true,
      "variants": [],
      "digitalDelivery": null
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "count": 1
  }
}
```

--------------------------------

### GET /api/v1/products/{productId}

Source: https://docs.sequenzy.com/api-reference/products/get

Retrieves a single product from the catalog by its identifier.

```APIDOC
## GET /api/v1/products/{productId}

### Description
Get a product from your catalog. This includes products pushed via the Commerce API, synced from integrations, and Stripe products with attached digital delivery files.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/products/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - Your product identifier (the productId used when upserting) or the internal product ID.

### Request Example
curl "https://api.sequenzy.com/api/v1/products/SKU-PROTEIN-1KG" \
  -H "Authorization: Bearer YOUR_API_KEY"

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **product** (object) - The product details.

#### Response Example
{
  "success": true,
  "product": {
    "id": "prod_abc123",
    "productId": "SKU-PROTEIN-1KG",
    "provider": "api",
    "title": "Protein Powder",
    "priceCents": 8850,
    "currency": "USD",
    "inStock": true,
    "variants": [],
    "digitalDelivery": null
  }
}
```

--------------------------------

### GET /api/v1/lists

Source: https://docs.sequenzy.com/api-reference/lists/list

Retrieves a list of subscriber lists for the authenticated company.

```APIDOC
## GET /api/v1/lists

### Description
List subscriber lists for the authenticated company.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/lists

### Request Example
curl "https://api.sequenzy.com/api/v1/lists" \
  -H "Authorization: Bearer YOUR_API_KEY"

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **lists** (array) - A list of subscriber list objects.

#### Response Example
{
  "success": true,
  "lists": [
    {
      "id": "list_abc123",
      "name": "Newsletter Subscribers",
      "description": "Subscribers interested in newsletter",
      "isPrivate": false,
      "createdAt": "2026-05-01T10:30:00Z"
    }
  ]
}
```

--------------------------------

### Initialize Sequenzy Client

Source: https://docs.sequenzy.com/quickstart

Configure the Sequenzy client using your API key stored in environment variables.

```typescript
import Sequenzy from "sequenzy";

const client = new Sequenzy({
  apiKey: process.env.SEQUENZY_API_KEY,
});
```

--------------------------------

### Initialize and Use Sequenzy SDK

Source: https://docs.sequenzy.com/api-reference/introduction

Configuration and common operations using the official TypeScript SDK.

```typescript
import Sequenzy from "sequenzy";

const client = new Sequenzy({
  apiKey: process.env.SEQUENZY_API_KEY,
});

// Create a subscriber
await client.subscribers.create({
  email: "user@example.com",
  firstName: "John",
  tags: ["new-signup"],
  customAttributes: { plan: "pro" },
  enrollInSequences: true,
});

// Add a tag
await client.subscribers.tags.add({
  email: "user@example.com",
  tag: "customer",
});

// Trigger an event
await client.subscribers.events.trigger({
  email: "user@example.com",
  event: "purchase_completed",
  properties: { orderId: "ORD-123", amount: 99.99 },
});

// Send a transactional email
await client.transactional.send({
  to: "user@example.com",
  slug: "welcome-email",
  variables: { firstName: "John" },
});
```

--------------------------------

### GET /api/v1/landing-pages

Source: https://docs.sequenzy.com/api-reference/landing-pages/list

Retrieves a list of landing pages for the authenticated company.

```APIDOC
## GET /api/v1/landing-pages

### Description
List landing pages for the authenticated company.

### Method
GET

### Endpoint
https://api.sequenzy.com/api/v1/landing-pages

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful
- **companyId** (string) - The ID of the company
- **landingPages** (array) - List of landing page objects
- **url** (string) - Dashboard URL for landing pages

#### Response Example
{
  "success": true,
  "companyId": "comp_abc123",
  "landingPages": [
    {
      "id": "lp_abc123",
      "companyId": "comp_abc123",
      "name": "Product Waitlist",
      "slug": "product-waitlist",
      "status": "published",
      "content": { "version": 2, "template": "waitlist", "blocks": [] },
      "viewCount": 1240,
      "conversionCount": 186,
      "publishedAt": "2026-05-01T10:30:00Z",
      "createdAt": "2026-05-01T10:00:00Z",
      "updatedAt": "2026-05-01T10:30:00Z",
      "url": "https://sequenzy.com/dashboard/company/comp_abc123/landing-pages/lp_abc123",
      "appPublicUrl": "https://sequenzy.com/lp/comp_abc123/product-waitlist",
      "publicUrl": "https://pages.example.com/product-waitlist"
    }
  ],
  "url": "https://sequenzy.com/dashboard/company/comp_abc123/landing-pages"
}
```

--------------------------------

### Create Sequence with Discount Action

Source: https://docs.sequenzy.com/api-reference/sequences/create

Automate the generation of provider-specific discount codes within a sequence step.

```bash
curl -X POST "https://api.sequenzy.com/api/v1/sequences" \
  -H "Authorization: Bearer seq_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Win-back Discount",
    "trigger": "tag_added",
    "tagName": "cancelled",
    "steps": [
      {
        "type": "create_discount",
        "discount": {
          "label": "Create win-back discount",
          "provider": "stripe",
          "discountType": "percent",
          "percentOff": 20,
          "duration": "once",
          "appliesToAllPlans": true,
          "maxRedemptions": 1,
          "lockToSubscriber": true,
          "codePrefix": "WINBACK"
        }
      },
      {
        "subject": "Come back with {{discount.code}}",
        "delay": { "days": 1 },
        "html": "<p>Use {{discount.code}} for {{discount.percentOff}}% off your next subscription.</p>"
      }
    ]
  }'
```
Tokens:
Raw