Documentation

Quickstart

Create a workspace, verify a domain and send the first message.

  1. 1. Create a workspace and verify a sending domain.
  2. 2. Publish the ownership TXT, SPF, DKIM and DMARC records shown in the dashboard.
  3. 3. Click verify. ACTIVE means SPF and DKIM are aligned.
  4. 4. Create an API key with the send scope.
  5. 5. POST a message and watch delivery events in the dashboard.
send your first message
curl -X POST https://transmitly.io/v1/emails \
  -H "Authorization: Bearer $TRANSMITLY_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: welcome-8f2c" \
  -d '{
    "from": "Notify <[email protected]>",
    "to": ["[email protected]"],
    "subject": "Welcome to Acme",
    "html": "<p>Your workspace is ready.</p>",
    "stream": "transactional",
    "tags": {"flow": "onboarding"}
  }'

Need the full API surface? OpenAPI 3.1.