Referenční dokumentace API

Odesílat e-mail

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

Přehled

Cílhttps://api.unbox.im/v1/email
MetodaPOST
Content-Typeapplication/json
OborJedna API klíč pro každou vlastní doménu

Generujte klíče v Účet → Domény → váš doména → API po dokončení ověření DNS. Celý tajný klíč je zobrazen jednou – uložte ho bezpečně. Volitelné SMTP přihlašovací údaje v téže nabídce Domény dodržují stejné pravidla pouze pro transakční poštu.

Pouze transakční pošta

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

Povolené použití

  • Ověření účtu, obnovení hesla a upozornění na bezpečnost
  • Potvrzení objednávek, faktury, aktualizace zásilky a upozornění na platby
  • Upozornění vyvolaná konkrétním uživatelem nebo systémovým událostí
  • Zprávy týmu a pracovního prostředí (přihlášky, přiřazení, vnitřní upozornění)

Zakázané použití

  • Novinky, kampaně nebo rozsáhlé marketingové kampaně
  • Chladné outreach nebo pošta na nakoupené, zkopírované nebo nezaměřené seznamy
  • Spamové affiliate, phishingové nebo dezinformační obsahy
  • Jakákoli pokus o obejití limitů příjemců, rychlostních omezení nebo kvót plánu

Omezení rychlosti a příjemců

Pro ochranu příjemců a zajištění doručení je výstupní API a SMTP provoz omezen níže uvedenými limity (kromě měsíčního výstupního kvóty vašeho plánu). Enforce se provádí na webu, HTTP API a SMTP. Web kompozitor varuje po 25 příjemcích na zprávu a blokuje odesílání nad 50.

OmezeníHodnota
Příjemci na zprávuAž 50 celkem (Do + Cc + Bcc dohromady)
Jedineční příjemci za denAž 1 000 na pracovní prostředí
Rychlost odesílání požadavkůAž 10 odesílání API nebo SMTP za minutu na doménu
Výstupní kvóta plánuMěsíční omezení odesílání na vašem předplatném stále platí

Tato pravidla jsou součástí našeho politiky přijatelného použití. Automatizovaná kontrola probíhá na webu, HTTP API a SMTP. Účty, které odesílají marketingové nebo masové e-maily, nebo jinak zneužívají infrastrukturu odesílání, mohou být omezena, zablokována nebo zrušena.

Monitorujeme signály doručitelnosti. Trvalé počty odmítnutí nad 3 % nebo reklamací nad 0,1 % mohou vyvolat dočasný zastavení odesílání nebo ruční revizi.

Podívejte se na naše Podmínky služby, Pravidla soukromí a Prohlášení GDPR pro plný popis politiky.

Autentizace

Odesílejte svůj API klíč domény na každý požadavek:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternativně použijte X-Api-Key: ubk_live_…. Klíče jsou uloženy hašovaně; zrušte nebo změňte z nabídky Domény.

Tělo požadavku

JSON s názvy polí ve stylu PascalCase (Od, Do, …). Také jsou přijímány aliasy ve stylu camelCase.

PolíčkoPovinnéPopis
FromAnoOdesílatel – váš osobní mailbox na doméně klíče (hlavní nebo alias). Společné fronty nejsou platnými odesílateli.
ToAnoPříjemce (více) – řetězec, řetězec oddělený čárkou nebo pole
SubjectAnoŘádek předmětu
TextBodyJedno z TextBody / HtmlBodyTextové tělo
HtmlBodyJedno z TextBody / HtmlBodyHTML tělo
CcNeKopie příjemců
BccNeBlind kopie příjemců
ReplyToNeAdresa pro odpověď
TagNeVolitelný metadatový tag (uložený spolu s odesláním)

Příklad

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

Úspěšná odpověď

HTTP 200 s JSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Odpovědi na chyby

Chyby vracejí 4xx (nebo 500 pro neočekávané chyby) s JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
ErrorCodeVýznam
0Úspěch
10Chybí API klíč
11Neplatný nebo zrušený klíč, nebo doména není ověřená pro odesílání
300Chyba ověření (chybí pole, neplatný JSON, atd.)
403Adresa odosílatelé není povolena — musí být váš osobní mailbox na doméně klíče
406SES odmítl zprávu

Příklady

Nahraďte you@yourdomain.com vaším osobním mailboxem na doméně a použijte svůj vlastní API klíč.

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

Začínáme

  1. Vytvořte účet Unbox a přidejte svou vlastní doménu.
  2. Dokončete všechny kroky ověření DNS v Doménech.
  3. Otevřete Doména → vaše doména → API a vygenerujte klíč domény.
  4. Odešlete svou první zprávu pomocí příkladů nahoře.
Unbox — Dokumentace API | Unbox.im