API Reference

Create account (org + user + session)

Login and receive session cookie

Destroy session

Get current user and organization

Send password reset email

Reset password with token

List all API keys for your org

Create a new API key

Revoke an API key

List all sites

Create a new site

Get site details

Update a site (name, domain, autoBcc, sendFrequencyCapDays, companyName, physicalAddress)

Delete a site (fails if site has sends)

List contacts with search, filter, pagination

Create a contact (with optional tags and lists)

Get contact details

Update contact fields

Delete a contact

Bulk create/update up to 100 contacts (note: uses siteId not siteId in body)

Export contacts as CSV or JSON (filter by list, tag, status, or segment)

List all lists for a site

Create a list

Get list details

Update a list

Delete a list

Search contacts to add to a list (requires ?q= param)

Add a contact to a list

Remove a contact from a list

List all tags for a site

Create a tag

Delete a tag

List all segments for a site

Create a segment with rules

Get segment details with live contact count

Update segment name, description, or rules

Delete a segment

List contacts matching segment rules (paginated)

Preview contact count for rules

Preview contact count without creating a segment

List all template folders

Create a folder (name)

Rename a folder (name)

Delete a folder (templates moved to unfiled)

List all templates (includes folderId)

Create a template (optional folderId)

Get template details

Update a template (name, subject, html, designJson, folderId)

Delete a template

Preview rendered HTML with sample variables

List sequences

Create a sequence. Optional sendingConfigId to use a specific sending config for all emails in the sequence.

Get sequence details

Update a sequence (name, status, triggerType, sendingConfigId, autoBcc)

Delete a sequence

Get sequence with steps, enrollments, and stats

Enroll contacts into the sequence. Optional startAtStep to begin at a specific step position.

List enrollments for a sequence

Create an enrollment

Cancel an enrollment

List steps in a sequence

Add steps to a sequence. Supports email, delay, and condition types. Condition steps accept conditionConfig (JSON), trueBranchStepOrder, and falseBranchStepOrder for workflow branching.

Update a step (type, templateId, delayMinutes, conditionConfig, trueBranchStepOrder, falseBranchStepOrder)

Remove a step

List pre-built sequence playbooks (no auth required)

Create a sequence from a playbook template (creates sequence + templates + steps)

List holiday emails for a site

Schedule a holiday email injection into active sequences

Get holiday details and send stats

Update a holiday (name, date, templateId, status). Set status to 'cancelled' to stop sending.

Delete a holiday and its send records

List campaigns

Create a campaign. Optional sendingConfigId to use a specific sending config.

Get campaign details, stats, and sendingConfigLabel

Update a campaign (name, templateId, listId, tagId, sendingConfigId, A/B test settings). Only draft or scheduled campaigns can be updated.

Delete a campaign

Schedule a campaign for future delivery

Send a campaign immediately. Requires sendingConfigId on the campaign. Supports A/B test variant splitting.

List all variants for a campaign

Create a variant (subject, template, or HTML override)

Get variant details with open/click rates

Update a variant

Delete a variant (deleting all disables A/B testing)

List all forms (optionally filter by siteId)

Create a form (siteId, name, designJson, sequenceId, listId, tags, doubleOptIn)

Get form details

Update a form (name, designJson, status, sequenceId, listId, tags, doubleOptIn)

Delete a form (cascades to submissions)

List form submissions (paginated)

Public form submission endpoint (no auth, rate limited by IP, CORS enabled)

List scoring rules (optionally filter by siteId)

Create a scoring rule

Get scoring rule details

Update a scoring rule

Delete a scoring rule

Get a contact's lead score and scoring log

Manually adjust a contact's lead score

List sent emails with status and cost

Get a single send by ID, including its full event history (delivered, open, click, bounce, etc.)

List email events (delivered, open, click, bounce, etc.)

Record a custom event for a contact

List custom events (filterable by contactId, eventName)

List all distinct custom event names in your org

Send a single transactional email. Pass fromEmail/fromName directly or use sendingConfigId. Requires templateId or html+subject. Pass secure: true for encrypted delivery.

Send up to 1000 emails in one call. Supports fromEmail/fromName or sendingConfigId, with per-recipient variables and tracking.

Validate an email address (syntax, MX, disposable check)

List suppressions (paginated, filterable by reason)

Add a manual suppression

Remove an email from the suppression list

Check if an email is suppressed

Bulk import suppressions from CSV or JSON

Export suppressions as CSV or JSON

List all secure messages for your org (with pagination)

Get secure message details (status, view count, expiry)

Revoke a secure message (deletes encrypted blob, marks as revoked)

List contacts actively enrolled in multiple sequences for a site

List active enrollments that haven't progressed in 24+ hours

Enrollment status breakdown per sequence (active, completed, cancelled, failed)

Subscribed contacts with 5+ sends who never opened or clicked

Subscribed contacts not enrolled in any active sequence

List all scheduled reports for your org

Create a scheduled report (daily, weekly, or monthly email delivery)

Get a scheduled report

Update a scheduled report (frequency, recipient, active)

Delete a scheduled report

Upload CSV and start import

List imports

Get import progress and stats

List available email providers with their display names, capabilities (supportsWebhooks, supportsBatch), and config fields

List sending configurations (returns provider, fromEmail, fromName, isByok, verified)

Add a sending config. Pass provider (sendgrid, ses, postmark, mailgun, sparkpost, brevo, mailjet, mandrill, resend, elastic-email) and credentials object with provider-specific fields (e.g. apiKey, region, domain). Defaults to sendgrid. Legacy apiKey field still accepted.

Update a sending config

Remove a sending config

Verify the config by sending a test email

List all verified and pending domains

Add a domain and start verification

Get domain details and DNS records

Remove a domain

Get current user settings and org info

Change your password

Update organization name

Get MFA status (TOTP and email OTP)

Generate TOTP secret and QR code URI

Verify TOTP code to complete setup

Disable TOTP authentication

Enable email-based OTP

Disable email-based OTP

Request an MFA challenge (sends email OTP)

Verify MFA code to complete login

Dashboard stats (contacts, sends, open rate)

Analytics data for charts and trends

Get deliverability metrics. Query param period accepts 7d, 30d, or 90d (default 30d). Returns funnel (sent, delivered, opened, clicked, bounced, failed), bounceBreakdown (hard, soft, block, topReasons), complaintRate, dailyTrends (per-day sent/delivered/opened/clicked/bounced with rates), ispBreakdown (top 20 recipient domains with delivery and open rates), configPerformance (per sending config stats), and reputation (score: excellent/good/fair/poor, bounceRate, complaintRate, factors).

List all available plans with features and pricing

Get your org's current plan, usage, and billing period

Preview or confirm a plan upgrade/downgrade with proration

Cancel subscription (remains active until period end)

Get current period usage vs plan limits

Get current month usage and credit balance

Get current plan, subscription details, and invoices

Create Stripe Checkout session for plan subscription

List available credit packages

Create Stripe Checkout session for credit purchase

Create Stripe Customer Portal session

Stripe webhook handler (called by Stripe, not by your app)

Get sending health, trust level, and rate limits

Get current rate limit usage for your org (general and send buckets)

Get branding discount status

Enable or disable branding footer (15% discount)

Get compliance settings (physical address, unsubscribe URL, enabled)

Update compliance settings

RFC 8058 one-click unsubscribe (called by email clients)

Browser-based unsubscribe confirmation page

Process browser-based unsubscribe

Search Pexels stock photos

Download a photo to R2 storage

Serve the JavaScript tracking snippet (Content-Type: application/javascript)

Record a page view or custom event (public, no auth)

Link an anonymous visitor to a known contact (public, no auth)

List outgoing webhook endpoints

Create an outgoing webhook endpoint

Get webhook endpoint details

Update a webhook endpoint

Delete a webhook endpoint

Receive SendGrid event webhooks (inbound)

SendGrid inbound events. Verifies ECDSA signature via x-twilio-email-event-webhook-signature header. Supports ?config_id= for per-config secrets.

Amazon SES inbound events via SNS. Auto-confirms SNS subscriptions. Supports ?config_id=&secret= query params for verification.

Postmark inbound events. Supports ?config_id=&secret= query params for verification.

Mailgun inbound events. Verifies HMAC-SHA256 signature. Supports ?config_id= for per-config secrets.

SparkPost inbound events. Supports ?config_id= for per-config secrets.

Brevo (Sendinblue) inbound events. Supports ?config_id=&secret= query params for verification.

Mailjet inbound events. Supports ?config_id=&secret= query params for verification.

Mandrill (Mailchimp Transactional) inbound events. Verifies webhook signature. Supports ?config_id= for per-config secrets.

Resend inbound events. Supports ?config_id=&secret= query params for verification.

Elastic Email inbound events. Supports ?config_id=&secret= query params for verification.