Skip to main content

​
Base URL

https://your-server.com/sendykit/api/v2
For SaaS: https://api.sendykit.dev/v2

​
Authentication

All API requests require authentication via one of: 
curl -H "X-API-Key: sk_a1b2c3d4..." \
  https://your-server.com/sendykit/api/v2/brands
API keys are SHA-256 hashed at rest, scoped (read, write, admin), and individually revocable.

​
JWT Token (for sessions)

# Get a token
curl -X POST https://your-server.com/sendykit/api/v2/auth/token \
  -d '{"username": "admin", "password": "..."}'

# Use it
curl -H "Authorization: Bearer eyJ..." \
  https://your-server.com/sendykit/api/v2/brands

​
Machine Payments (for agents)

For premium actions, SendyKit can require Stripe-native machine-payment proof: 
curl -H "X-Stripe-Machine-Payment: <payment-proof-or-intent-ref>" \
  https://your-server.com/sendykit/api/v2/campaigns
Use API keys for standard authenticated automation. Use Stripe-native machine-payment proofs for premium machine-paid actions.

​
Response Format

All responses use a consistent JSON envelope: 
{
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 142
  }
}
Error responses: 
{
  "error": "subscriber not found",
  "code": "not_found",
  "status": 404
}

​
Idempotency

For write operations (POST, PUT, DELETE), include an Idempotency-Key header to prevent duplicate processing: 
curl -X POST \
  -H "X-API-Key: sk_..." \
  -H "Idempotency-Key: unique-request-id-123" \
  -d '{"email": "user@example.com", "list_id": 1}' \
  https://your-server.com/sendykit/api/v2/subscribers

​
Rate Limiting

Rate limits are returned in response headers: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1710345600
Default limits per API key. Contact support for higher limits.

​
Endpoint Categories

SendyKit’s generated API reference covers the major families below. Use the API Reference tab navigation and OpenAPI-powered endpoint pages for the full route surface.
CategoryDescription
BrandsMulti-brand management
ListsMailing list CRUD + custom fields
SubscribersFull subscriber lifecycle + bulk operations
CampaignsCampaign CRUD, scheduling, sending, and reports
TemplatesTemplate management
AnalyticsDelivery, engagement, and campaign intelligence
AISubject lines, email generation, rewrites, and insights
WebhooksEvent subscriptions and delivery operations
SystemHealth, doctor, audit, flags, and operational endpoints
BillingStatus, customer state, licensing, and machine-payment receipts
The endpoint pages in the API Reference tab are generated from the canonical OpenAPI spec, so they stay aligned with the live contract more reliably than hand-maintained deep links.