Agent-readable docs index: /docs/llms.txt. Full docs in one file: /docs/llms-full.txt. Download /docs/docs.zip to grep all markdown files locally.

Workspaces, audiences and delivery concepts

A workspace is the ownership boundary for contacts, lists, keys, senders, templates, campaigns, segments, and automations. An API key resolves its workspace on the server. IDs from another workspace cannot be used to update contacts or select a sender.

Contacts and audiences

A contact stores customer identifiers, profile data, custom fields, and messaging preferences. Each contact row has a primary list. The same normalized destination may appear in more than one list, so use a stable contact ID or external customer ID when a lookup would otherwise be ambiguous.
A list groups stored contact rows. A segment evaluates a rule definition over all contacts or selected lists. Preview counts estimate eligibility at a moment in time; delivery services recheck preferences, suppression, and channel readiness later.

Templates, campaigns and API sends

Templates hold reusable content and required variables. Campaigns send reviewed content to an audience. Transactional API sends target one recipient, while batches queue independently personalized messages in one request.
Purpose affects eligibility. Choose marketing for promotional journeys and campaigns; use the transactional flow for service notifications and verification. A purpose field is not a bypass for consent, suppression, plan limits, or provider rules.

Versions and executions

Published segments and automation versions are immutable snapshots. Saving edits creates a draft. Automation executions continue with the version they entered, and campaigns pin the published segment definition when sending begins.
An execution is one contact's run through a workflow. Its step history records progress through sends, waits, decisions, and contact updates. Pausing and archiving have different effects from canceling queued messages.

Delivery vocabulary

  • Queued/pending: work is accepted and waiting for a worker or provider pacing.
  • Sent/accepted: submitted successfully to the provider; this is not an inbox or device-delivery guarantee.
  • Delivered: a provider delivery receipt was received.
  • Read/opened/clicked: engagement signals where the channel supports them; email privacy behavior can affect opens.
  • Failed/skipped/suppressed: delivery did not proceed or complete; inspect the reason before retrying.
Next: choose channel routing or contact management.
Money and messages have separate checkpoints. A pending message may hold a reservation while waiting. Check billing before interpreting an available balance.