Developers

API and integration surface

Workspace-scoped APIs verified from the backend route inventory for draft campaign management, readiness checks, and inbox workflows.

Security
No-send postureDocumentation is read-only. Any live send or provider mutation stays locked until explicitly approved.

Authentication

Bearer tokens
  • Bearer tokens are workspace-scoped.
  • Keep live sends disabled unless a task explicitly approves them.
  • Use the API to inspect readiness and draft data before any external action.

Auth

  • POST /api/auth/login
  • GET /api/auth/me
  • Workspace-scoped bearer token authentication

Contacts

  • GET /api/workspaces/{workspaceId}/contacts
  • POST /api/workspaces/{workspaceId}/contacts/import

Campaigns

  • GET /api/workspaces/{workspaceId}/campaigns
  • POST /api/workspaces/{workspaceId}/campaigns
  • PUT /api/workspaces/{workspaceId}/campaigns/{campaignId}/steps
  • POST /api/workspaces/{workspaceId}/campaigns/{campaignId}/recipients
  • GET /api/workspaces/{workspaceId}/campaigns/{campaignId}/recipient-preview
  • POST /api/workspaces/{workspaceId}/campaigns/{campaignId}/compliance-preflight
  • GET /api/workspaces/{workspaceId}/campaigns/{campaignId}/render-preview

Mailboxes and send readiness

  • GET /api/workspaces/{workspaceId}/mailboxes
  • POST /api/workspaces/{workspaceId}/mailboxes/sync-manifest
  • GET /api/workspaces/{workspaceId}/send-capability/readiness
  • GET /api/workspaces/{workspaceId}/deliverability/health
  • GET /api/workspaces/{workspaceId}/deliverability/dns-authentication
  • GET /api/workspaces/{workspaceId}/deliverability/reputation-trends

Warmup

  • GET /api/workspaces/{workspaceId}/warmup/dashboard
  • GET /api/workspaces/{workspaceId}/warmup/profiles
  • PUT /api/workspaces/{workspaceId}/warmup/profiles/{mailboxId}
  • POST /api/workspaces/{workspaceId}/warmup/simulate
  • POST /api/workspaces/{workspaceId}/warmup/readiness-verify

Inbox and reply review

  • GET /api/workspaces/{workspaceId}/inbox-preview
  • GET /api/workspaces/{workspaceId}/campaigns/{campaignId}/inbound-reply-review
  • POST /api/workspaces/{workspaceId}/inbox-review/bulk-mark-safe

Example workflow

No-send
  1. Authenticate with a workspace-scoped bearer token.
  2. Inspect contacts, mailboxes, and readiness data.
  3. Create or update a draft campaign.
  4. Preview schedule and deliverability before any launch decision.
  5. Use backend automation against documented routes for integrations.