# Docs

- [Introduction](/docs): emitd is transactional email as a plain HTTPS API — send from any language in a single request.
- [Quickstart](/docs/quickstart): Send your first email through the emitd API in under five minutes.
- [Authentication](/docs/authentication): API keys, permission scopes, and domain-scoped keys for the emitd API.
- [Test mode](/docs/sandbox): Simulate deliveries, bounces, and complaints without touching real email.
- [Rate limits & quotas](/docs/rate-limits): Per-minute burst limits, plan send quotas, response headers, and 429 semantics.
- [Idempotency](/docs/idempotency): Retry sends safely with the Idempotency-Key header.
- [SDKs & CLI](/docs/sdks): Official SDKs for nine languages, generated from the OpenAPI spec — or plain HTTPS.

- **Separator**
- Guides
  - [Send an email](/docs/guides/send-email): POST /v1/email — body parameters, templates, scheduling, attachments, and the response shape.
  - [Batch sending](/docs/guides/batch): POST /v1/email/batch — up to 100 messages per call with per-message results.
  - [Templates](/docs/guides/templates): Server-side rendered email templates with immutable versions and {{ variable }} substitution.
  - [Sending domains](/docs/guides/domains): Verify a domain, publish the DNS records, and scope keys to it.
  - [Webhooks](/docs/guides/webhooks): Subscribe to delivery events, verify HMAC signatures, and handle retries and replays.
  - [Suppressions](/docs/guides/suppressions): The per-tenant do-not-send list — how sends get blocked, and how to manage the list.
  - [Message activity](/docs/guides/message-activity): Look up delivery status per message, filter by tags, and read events.
  - [Contacts & audiences](/docs/guides/contacts): The marketing contact store — CRUD, batch upserts, CSV import/export, audiences, and segments.
  - [Broadcasts](/docs/guides/broadcasts): One-off marketing sends to an audience or segment — create, send, cancel, stats.
  - [AI agents & MCP](/docs/guides/agents): Give an AI agent a send-email tool with emitd's Model Context Protocol endpoint.
- Frameworks
  - [Next.js](/docs/frameworks/nextjs): Send transactional emails from Next.js in five minutes — no SDK, one fetch.
  - [Ruby on Rails](/docs/frameworks/rails): Send transactional emails from Rails with one Net::HTTP.post — no SDK.
  - [Django](/docs/frameworks/django): Send transactional emails from Django with one requests.post — no SDK.
- API reference
  - [API reference](/docs/api): Every emitd endpoint, generated from the OpenAPI spec.
  - Email: Send transactional/marketing email, manage scheduled sends.
    - [Send an email](/docs/api/email/sendEmail)
    - [Send a batch of emails](/docs/api/email/sendBatch)
    - [Reschedule a queued or scheduled send](/docs/api/email/rescheduleEmail)
    - [Cancel a queued or scheduled send](/docs/api/email/cancelScheduledEmail)
    - [List simulated events for test-mode sends](/docs/api/email/listTestEvents)
  - Messages: Read-only message activity log.
    - [List message activity](/docs/api/messages/listMessages)
    - [Get message detail](/docs/api/messages/getMessage)
  - Contacts: Marketing contact store (CRUD, batch, CSV import/export).
    - [List contacts](/docs/api/contacts/listContacts)
    - [Create or upsert a contact](/docs/api/contacts/createContact)
    - [Get a contact](/docs/api/contacts/getContact)
    - [Update a contact](/docs/api/contacts/patchContact)
    - [Delete a contact](/docs/api/contacts/deleteContact)
    - [Upsert up to 100 contacts](/docs/api/contacts/batchUpsertContacts)
    - [Start an async CSV contact import](/docs/api/contacts/createContactImport)
    - [Get a contact import job's status](/docs/api/contacts/getContactImport)
    - [Start an async GDPR contact export](/docs/api/contacts/createContactExport)
    - [Get a contact export job's status](/docs/api/contacts/getContactExport)
    - [Download a finished contact export](/docs/api/contacts/downloadContactExport)
  - Audiences: Static contact lists and their membership.
    - [List audiences](/docs/api/audiences/listAudiences)
    - [Create an audience](/docs/api/audiences/createAudience)
    - [Get an audience](/docs/api/audiences/getAudience)
    - [Rename or redescribe an audience](/docs/api/audiences/patchAudience)
    - [Delete an audience](/docs/api/audiences/deleteAudience)
    - [List an audience's members](/docs/api/audiences/listAudienceMembers)
    - [Add one contact to an audience](/docs/api/audiences/addAudienceMember)
    - [Add up to 100 contacts to an audience](/docs/api/audiences/addAudienceMembersBulk)
    - [Remove a contact from an audience](/docs/api/audiences/removeAudienceMember)
  - Segments: Saved (and ad-hoc) contact filters.
    - [List segments](/docs/api/segments/listSegments)
    - [Create a saved segment](/docs/api/segments/createSegment)
    - [Preview an ad-hoc filter without saving it](/docs/api/segments/previewAdhocSegment)
    - [Get a segment](/docs/api/segments/getSegment)
    - [Rename or replace a segment's filter](/docs/api/segments/patchSegment)
    - [Delete a segment](/docs/api/segments/deleteSegment)
    - [Preview a saved segment's matching contacts](/docs/api/segments/previewSegment)
    - [Get a saved segment's live match count](/docs/api/segments/countSegment)
  - Suppressions: Per-tenant suppression (do-not-send) list.
    - [List suppressions](/docs/api/suppressions/listSuppressions)
    - [Add a suppression](/docs/api/suppressions/addSuppression)
    - [Add up to 100 suppressions](/docs/api/suppressions/bulkAddSuppressions)
    - [Remove up to 100 suppressions](/docs/api/suppressions/bulkRemoveSuppressions)
    - [Remove a suppression](/docs/api/suppressions/deleteSuppression)
  - Templates: Server-side rendered templates with immutable versions.
    - [List templates](/docs/api/templates/listTemplates)
    - [Create a template](/docs/api/templates/createTemplate)
    - [Get a template and its versions](/docs/api/templates/getTemplate)
    - [Create a new template version](/docs/api/templates/createTemplateVersion)
  - Webhooks: Event webhook endpoint registration and replay.
    - [List webhook endpoints](/docs/api/webhooks/listWebhooks)
    - [Create a webhook endpoint](/docs/api/webhooks/createWebhook)
    - [Delete a webhook endpoint](/docs/api/webhooks/deleteWebhook)
    - [Replay webhook deliveries](/docs/api/webhooks/replayWebhook)
  - Inbound: Received email (Cloudflare Email Routing) activity.
    - [List received email](/docs/api/inbound/listInbound)
    - [Get a received message, including raw MIME](/docs/api/inbound/getInboundMessage)
  - Attachments: Upload and retrieve email attachments via R2.
    - [Upload an attachment](/docs/api/attachments/uploadAttachment)
    - [Download an attachment](/docs/api/attachments/serveAttachment)
  - Health: Unauthenticated service health check.
    - [Health check](/docs/api/health/healthCheck)
  - Broadcasts: One-off marketing sends to an audience or segment.
    - [List broadcasts](/docs/api/broadcasts/listBroadcasts)
    - [Create a draft broadcast](/docs/api/broadcasts/createBroadcast)
    - [Get a broadcast](/docs/api/broadcasts/getBroadcast)
    - [Edit a draft broadcast](/docs/api/broadcasts/patchBroadcast)
    - [Delete a broadcast](/docs/api/broadcasts/deleteBroadcast)
    - [Validate and send (or schedule) a draft broadcast](/docs/api/broadcasts/sendBroadcast)
    - [Cancel a draft or scheduled broadcast](/docs/api/broadcasts/cancelBroadcast)
  - Automations: Event-triggered, multi-step marketing workflows.
    - [List automations](/docs/api/automations/listAutomations)
    - [Create a draft automation](/docs/api/automations/createAutomation)
    - [Get an automation](/docs/api/automations/getAutomation)
    - [Edit a draft automation](/docs/api/automations/patchAutomation)
    - [Delete an automation](/docs/api/automations/deleteAutomation)
    - [Activate an automation](/docs/api/automations/activateAutomation)
    - [Pause an active automation](/docs/api/automations/pauseAutomation)
    - [Archive an automation](/docs/api/automations/archiveAutomation)
    - [Manually enroll a contact](/docs/api/automations/enrollInAutomation)
- Reference
  - [Errors](/docs/reference/errors): The error envelope, status codes, and every stable error code.
  - [Webhook events](/docs/reference/webhook-events): Every event type emitd delivers, the payload shape, and what each one means.
  - [Pagination](/docs/reference/pagination): limit/cursor pagination on every list endpoint, and which cursor style each resource uses.