Email API

Send transactional emails (password reset, notices, confirmations) through Sendeasy from your own application, authenticated by the token of the email itself — every email configured in the project has its own.

Messages go out from the email that owns the token and consume 1 email credit of the project. You never pass the sender: it is the token's email. Have more than one email? Use the token of the one you want to send from.

Prerequisites

1. Email token — in Channels → Email (or on the email card in Channels) → Settings → Sending API section. Each email has its own token; you can also generate a new one there (the previous one stops working immediately).
2. The email with status Verified (same place). Without it the route answers 503 ERR_EMAIL_SENDER_NOT_CONFIGURED and nothing is sent, even with credits.
3. Email credits available in the project plan.

Use GET /api/v1/email/health to check items 1 and 2 without spending credits.

Authentication

Required header, with the sender email's token:

Authorization: Bearer <email_token>

The token identifies the sender email and, through it, the project — there is no whatsappId/emailId in the URL.

Endpoints

Rate limit: 20 requests per minute per origin (429 ERR_PUBLIC_EMAIL_RATE_LIMIT).

Sending an email

POST /api/v1/email/send

Payload

Example

curl --location 'https://server.sendeasy.pro/api/v1/email/send' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer EMAIL_TOKEN' \
  --data '{
    "to": "customer@example.com",
    "subject": "Password reset",
    "fromName": "My Platform",
    "html": "<p>Hi! Click the link below to create a new password.</p>"
  }'

Success response:

{
  "success": true,
  "id": "9fbbb3a9-4c1e-4b1a-9d1e-0c2b7e3f5a61"
}

id is the provider's identifier for the send. The response confirms the email was accepted for delivery — final delivery depends on the recipient's mail server.

Integration diagnostics

GET /api/v1/email/health

Does not consume credits. Tells whether the token's email is already verified — the most common reason a send fails even with credits available.

curl --location 'https://server.sendeasy.pro/api/v1/email/health' \
  --header 'Authorization: Bearer EMAIL_TOKEN'

{
  "ok": true,
  "senderConfigured": true,
  "sender": "no-reply@yourcompany.com",
  "domain": "yourcompany.com",
  "channelId": 12
}

With senderConfigured: false, finish verifying the email in Channels → Email before sending. (With the project API Token the response has no channelId and tells whether the project has any verified email.)

Credits and refunds

• Every accepted send debits 1 email credit from the project.
• With no credits, the route answers 402 ERR_NO_EMAIL_CREDITS before any debit.
• If the send fails after the debit (sender not configured, provider unavailable), the credit is refunded automatically and the route answers 502/503.

Error codes

Email API vs. Custom integration

Sendeasy offers two ways to send email by API — pick by the kind of token you have:

Custom integration details at /en/server/integracoes.