API Reference

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

Authorization: Bearer YOUR_API_KEY

{
  "success": true,
  "data": { ... }
}

{
  "success": false,
  "error": "Human readable error message"
}

# This single request will:
# 1. Create the subscriber (if new)
# 2. Create the "customer" tag (if new)
# 3. Add the tag to the subscriber

curl -X POST "https://api.sequenzy.com/api/v1/subscribers/tags" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "new-user@example.com",
    "tag": "customer"
  }'

curl "https://api.sequenzy.com/api/v1/subscribers?page=2&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 2,
    "limit": 50,
    "total": 1250,
    "totalPages": 25
  }
}

{
  "success": false,
  "error": "The service could not reach its database for a moment. Retry the request.",
  "code": "SERVICE_UNAVAILABLE"
}

{
  "type": "validation",
  "on": "body",
  "property": "/enrollmentMode",
  "message": "Expected union value",
  "summary": "Property 'enrollmentMode' must be one of: unlimited, one_time, matching_field",
  "found": { "name": "Welcome series", "enrollmentMode": "once" },
  "errors": [
    {
      "path": "/enrollmentMode",
      "message": "Expected union value",
      "summary": "Property 'enrollmentMode' must be one of: unlimited, one_time, matching_field",
      "allowedValues": ["unlimited", "one_time", "matching_field"]
    }
  ]
}

{
  "success": true,
  "campaign": { "id": "camp_abc123", "name": "Weekly Report" },
  "ignoredFields": [{ "path": "sendAt", "reason": "unknown_field" }]
}

{
  "success": false,
  "error": "Subscriber not found"
}

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

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" },
});

pip install sequenzy                          # Python
composer require sequenzy/sequenzy            # PHP
go get github.com/sequenzy/sequenzy-go        # Go

async function addTag(email, tag) {
  const response = await fetch(
    "https://api.sequenzy.com/api/v1/subscribers/tags",
    {
      method: "POST",
      headers: {
        Authorization: `Bearer ${process.env.SEQUENZY_API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ email, tag }),
    }
  );
  return response.json();
}

import requests

def add_tag(email, tag):
    response = requests.post(
        "https://api.sequenzy.com/api/v1/subscribers/tags",
        headers={
            "Authorization": f"Bearer {SEQUENZY_API_KEY}",
            "Content-Type": "application/json"
        },
        json={"email": email, "tag": tag}
    )
    return response.json()

curl -X POST "https://api.sequenzy.com/api/v1/subscribers/tags" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "tag": "customer"}'