API-referens

Skicka e-post

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.

Översikt

Slutpunkthttps://api.unbox.im/v1/email
MetodPOST
Innehållstypapplication/json
OmfångEn API-nyckel per anpassad domän

Generera nycklar i Konto → Domäner → din domän → API efter att DNS-verification är klar. Den fulla hemligheten visas en gång – lagring är säkerställd. Valfria SMTP-credentials i samma Domäner-panel följer samma regler för endast transaktionsmail.

Endast transaktionsmail

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.

Tillåtna användningsområden

  • Kontobekräftelse, återställning av lösenord och säkerhetsaviseringar
  • Beställningsbekräftelser, kvitton, skickuppdateringar och betalningsmeddelanden
  • Aviseringar som utlöstas av ett specifikt användare eller systemhändelse
  • Team- och arbetsutrymmesmeddelanden (bjudningar, tilldelningar, interna aviseringar)

Förbjudna användningsområden

  • Nyhetsbrev, promotoriska kampanjer eller broadcast-marknadsföring
  • Kall utgående eller mail till köpta, skrapade eller icke-samtyckta listor
  • Affiliate-spam, phishing eller bedräglig innehåll
  • Villkor att undvika mottagargränser, sändningsgränser eller plankvoter

Sändnings- och mottagargränser

För att skydda mottagare och leveransförmågan är utgående API- och SMTP-trafik under ämnesgränserna nedan (i tillägg till din plan's månadsutgående kvot). Tillämpning är aktiv på webbkompositören, HTTP API och SMTP-överföring. Webbkompositören varnar efter 25 mottagare per meddelande och blockerar sändningar över 50.

GränsVärde
Mottagare per meddelandeUpp till 50 totalt (To + Cc + Bcc sammanlagt)
Unika mottagare per dagUpp till 1 000 per arbetsutrymme
Sändningsförfrågans hastighetUpp till 10 API- eller SMTP-överföringar per minut per domän
Plan utgående kvotMånadsutgående kvoter på din prenumeration gäller fortfarande

Dessa regler är en del av vår Acceptable Use Policy. Automatisk tillämpning är aktiv på webbkompositören, HTTP API och SMTP-överföring. Konton som skickar marknadsföring eller bulk-mail, eller annat missbruk av sändningsinfrastruktur, kan bli begränsade, satt i paus eller avslutades.

Vi övervakar leveranssignalerna. Sustained bounce rates över 3% eller klagorater över 0,1% kan utlösa en temporär sändningspaus eller manuell granskning.

Se vår Terms of Service, Privacy Policy och GDPR Statement för fullständiga policydetaljer.

Autentisering

Skicka din domän API-nyckel vid varje förfrågan:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternativt, använd X-Api-Key: ubk_live_…. Nycklar lagras hashade; återkalla eller rotera från Domäner-dashboards.

Förfrågans brödtext

JSON med PascalCase-fält (t.ex. From, To, …). camelCase-alias är också accepterade.

FältObligatorisktBeskrivning
FromJaAvsändare – din personliga mailbox på nyckelns domän (huvud eller alias). Delade köer är inte giltiga avsändare.
ToJaMottagare (flera) – sträng, kommaavgränsad sträng eller array
SubjectJaRubrik
TextBodyEn av TextBody / HtmlBodyTextkropp
HtmlBodyEn av TextBody / HtmlBodyHTML-kropp
CcNejKopiera mottagare
BccNejBlind kopiera mottagare
ReplyToNejSvaradress
TagNejValfritt metadata-tag (sparas tillsammans med skicket)

Exempel

{
  "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"
}

Lyckad svar

HTTP 200 med JSON:

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

Fel svar

Fel returnerar 4xx (eller 500 för oväntade fel) med JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
FelkodBetydelse
0Lyckad
10Försvunnen API-nyckel
11Ogiltig eller återkallad nyckel, eller domän inte verifierad för skick
300Valideringsfel (missande fält, ogiltig JSON, etc.)
403Från-adress inte tillåten — måste vara din personliga mailbox på nyckelns domän
406SES förnekade meddelandet

Exempel

Ersätt you@yourdomain.com med din personliga mailbox på domänen och använd din egen API-nyckel.

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"
}'

Kom igång

  1. Skapa ett Unbox-konto och lägg till din anpassade domän.
  2. Färdigställ alla DNS-verifieringssteg i Domäner.
  3. Öppna Domäner → din domän → API och generera en domännyckel.
  4. Skicka ditt första meddelande med exemplen ovan.
Unbox — API Dokumentation | Unbox.im