API-reference

Send 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.

Oversigt

Slutpunkthttps://api.unbox.im/v1/email
MetodePOST
Indholdstypeapplication/json
OmfangEn API-nøgle per brugerdomæne

Generer nøgler i Konto → Domæner → din domæne → API efter DNS-verification er færdig. Den fulde hemmelighed vises kun én gang – lagre den sikkert. Valgfri SMTP-koordinater i samme Domains-panel følger samme transaktionsbrev-regler.

Kommunikationsbrev kun

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.

Tilladte brug

  • Kontovalidering, adgangskodegenbrug og sikkerhedsvarsel
  • Ordrebekræftelser, kvitteringer, leveringsoptdateringer og betalingsnoter
  • Varer, der udløses af et bestemt bruger- eller systemhændelse
  • Team og workspace beskeder (inviteringer, opgaver, interne varsel)

Forbudte brug

  • Nyhedsbrev, markedsføring, eller broadcast-markedsføring
  • Kold outreach eller mail til købte, skabte eller ikke-konsentrerende lister
  • Affiliat-spam, phishing eller bedrageriindhold
  • Enhver forsøg på at omgå modtagergrænser, hastighedsgrænser eller abonnementskvoter

Grænser og modtægtere

For at beskytte modtægtere og levering, er udgående API og SMTP-trafik underkastet følgende grænser (uden for din abonnements månedlige udgående kvote). Gennemførelse er aktiv på webkomponering, HTTP API og SMTP-udsendelse. Webkomponeringen advarer efter 25 modtægtere per besked og blokerer sendebeholdninger over 50.

GrænseVærdi
Modtægtere per beskedOp til 50 i alt (Til + Cc + Bcc samlet)
Unikke modtægtere per dagOp til 1.000 per workspace
SendeforespørgselshastighedOp til 10 API eller SMTP-udsendelser per minut per domæne
Abonnements udgående kvoteMånedlige sendegrænser på din abonnement stadig gælder

Disse regler er en del af vores Acceptable Use Policy. Automatisk gennemførelse er i gang på webkomponering, HTTP API og SMTP-udsendelse. Konti, der sender markedsføring eller masseemail, eller på anden måde misbruger sendingsinfrastrukturen, kan blive forsinket, suspenderet eller afsluttet.

Vi overvåger leveringsmålsnåelse. Sustinerede bounce-rater over 3% eller klagen-rater over 0,1% kan udløse en midlertidig sendepause eller manuel gennemgang.

Se vores Brugervilkår, Personvilkår og GDPR-erklæring for fuld politikdetaljer.

Autentificering

Send din domæne API-nøgle på hver anmodning:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternativt, brug X-Api-Key: ubk_live_…. Nøglerne er gemt hashet; revokér eller roter fra Domains-dashboards.

Anmodningsbrød

JSON med felter i PascalCase (Fra, Til, …). camelCase-aliaser er også accepteret.

FeltPåkrævetBeskrivelse
FromJaSender – din personlige mailbox på nøglernes domæne (hoved- eller alias). Delte køer er ikke gyldige sendere.
ToJaModtager(e) – en streng, komma-separated streng eller array
SubjectJaEmne
TextBodyEt af TextBody / HtmlBodyTekstbrød
HtmlBodyEt af TextBody / HtmlBodyHTML-brød
CcNejKopier modtægtere
BccNejBlind kopier modtægtere
ReplyToNejSvar-til adresse
TagNejValgfri metadata-tag (lagret sammen med senden)

Eksempel

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

Succesrespons

HTTP 200 med JSON:

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

Fejlsvar

Fejl returnerer 4xx (eller 500 ved uventede fejl) med JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
FejlkodeBetydning
0Succes
10Manglende API-nøgle
11Ugyldig eller opsiget nøgle, eller domæne ikke godkendt til sende
300Valideringsfejl (manglende felter, ugyldig JSON osv.)
403Fra-adresse ikke tilladt – skal være din personlige postkasse på nøkkens domæne
406SES afviste beskeden

Eksempler

Erstat you@yourdomain.com med din personlige postkasse på domænet og brug din egen API-nøgle.

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

Start her

  1. Opret en Unbox-konto og tilføj din brugerdefinerede domæne.
  2. Færdiggør alle DNS-verificationsskridt i Domæner.
  3. Åbn Domæner → din domæne → API og generer en domænenøgle.
  4. Send din første besked med eksemplerne ovenfor.
Unbox — API-dokumentation | Unbox.im