shipmail

API

Manage domains, mailboxes, messages, and webhooks over HTTP. All endpoints share a single base URL and the same conventions.

Base URL

https://shipmail.to/api/v1

Conventions

  • Authenticate with a Bearer token in the Authorization header.
  • Request and response bodies use JSON with snake_case field names.
  • Every response includes an X-Request-Id header for debugging.
  • Timestamps are ISO 8601 strings in UTC.
  • IDs are prefixed strings (e.g. dom_, mbx_, msg_).

Reference

Authentication

Create API keys and authenticate requests with Bearer tokens.

Errors

Error envelope format, error types, and status codes.

Rate limits

Request quotas by tier and rate limit response headers.

Pagination

Cursor-based pagination for list endpoints.

Idempotency

Safely retry POST requests with idempotency keys.

Domains

Create, list, update, delete, and verify domains.

Mailboxes

Create, list, update, and delete mailboxes on your domains.

Messages

Send email and retrieve individual messages.

Threads

List threads, view thread messages, and reply to threads.

Webhooks

Subscribe to events with HTTPS webhooks.

Webhook verification

Verify webhook signatures and prevent replay attacks.

Status

Health check endpoint for monitoring.