API reference

Recipes

Production-shaped curls for the public surface. Assistant recipes stay portal-gated after admin approval.

Validate an API key

me:read

Health-check before ChatGPT actions, MCP bridges, Postman, or backend jobs.

curl https://api.statxe.com/api/v1/me \
  -H "Authorization: Bearer stx_live_xxx"

List sending domains

domains:read

Discover verified domains and sender identities for outbound mail.

curl https://api.statxe.com/api/v1/domains \
  -H "Authorization: Bearer stx_live_xxx"

Create a contact

contacts:write

Idempotent contact upsert-friendly create.

curl https://api.statxe.com/api/v1/contacts \
  -X POST \
  -H "Authorization: Bearer stx_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: contact_123_first_sync" \
  -d '{
    "email": "ada@example.com",
    "first_name": "Ada",
    "tags": ["customer"]
  }'

List inbox threads

inbox.threads:read

Read recent conversation threads.

curl "https://api.statxe.com/api/v1/inbox/threads?limit=20" \
  -H "Authorization: Bearer stx_live_xxx"

Create an outbox broadcast

outbox.broadcasts:write

Queue a broadcast for eligible recipients.

curl https://api.statxe.com/api/v1/outbox/broadcasts \
  -X POST \
  -H "Authorization: Bearer stx_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: broadcast_spring_launch" \
  -d '{
    "name": "Spring launch",
    "subject": "You’re invited",
    "segment_id": "seg_123"
  }'

Subscribe to webhooks

webhooks:write

Receive contact, email, and compliance events with signed delivery.

curl https://api.statxe.com/api/v1/webhooks \
  -X POST \
  -H "Authorization: Bearer stx_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: webhook_primary_prod" \
  -d '{
    "name": "Production events",
    "url": "https://example.com/api/statxe/webhooks",
    "events": ["contact.created", "email.delivered", "email.bounced"]
  }'