Transactional API

One call. One application event. One recipient.

An idempotency key is required, with an approved use case and an approved template by default.

Send with a template

A ym_test_ key validates the entire request without delivering it. A ym_live_ key is created only after the workspace and domain have been reviewed.

POST /v1/emails

Authorization: Bearer ym_live_…

Idempotency-Key: order-1234

Download the OpenAPI specification

curl https://api.mail.yodev.fr/v1/emails \
  -H "Authorization: Bearer ym_live_..." \
  -H "Idempotency-Key: order-1234" \
  -H "Content-Type: application/json" \
  -d '{
    "from": { "email": "notifications@client.fr" },
    "to": { "email": "alice@example.com" },
    "category": "payment_receipt",
    "content": {
      "templateId": "00000000-0000-0000-0000-000000000000",
      "variables": { "invoiceNumber": "INV-123" }
    },
    "metadata": { "referenceId": "order_123" }
  }'