API-referanse

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

Oversikt

Endepunkthttps://api.unbox.im/v1/email
MetodePOST
Content-Typeapplication/json
OmfangÉn API-nøkkel per tilpasset domene

Generer nøkler i Konto → Domener → ditt domene → API etter at DNS-verifisering er fullført. Den fullstendige hemmeligheten vises én gang — oppbevar den sikkert. Valgfrie SMTP-innlogginger i samme Domenepanel følger de samme reglene for kun transaksjonell e-post.

Kun transaksjonell e-post

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.

Tillatte bruksområder

  • Kontobekreftelse, tilbakestilling av passord og sikkerhetsvarsler
  • Ordrebekreftelser, kvitteringer, fraktoppdateringer og betalingsmeldinger
  • Varsler utløst av en bestemt bruker- eller systemhendelse
  • Team- og arbeidsområdemeldinger (invitasjoner, oppgaver, interne varsler)

Forbudte bruksområder

  • Nyhetsbrev, kampanjer eller kringkastingsmarkedsføring
  • Kald oppsøking eller e-post til kjøpte, skrapte eller ikke-samtykkende lister
  • Affiliatespam, phishing eller villedende innhold
  • Ethvert forsøk på å omgå mottakertak, rategrenser eller plankvoter

Rate- og mottakergrenser

For å beskytte mottakere og leverbarhet, er utgående API- og SMTP-trafikk underlagt grensene nedenfor (i tillegg til planens månedlige utsendelseskvote). Håndheving er aktiv i nettskriveren, HTTP API og SMTP-innsending. Nettskriveren advarer etter 25 mottakere per melding og blokkerer sendinger over 50.

GrenseVerdi
Mottakere per meldingOpptil 50 totalt (Til + Kopi + Skjult kopi)
Unike mottakere per dagOpptil 1 000 per arbeidsområde
SendingsfrekvensOpptil 10 API- eller SMTP-innsendinger per minutt per domene
Planens utsendelseskvoteMånedlige sendegrenser på abonnementet ditt gjelder fortsatt

Disse reglene er en del av vår akseptable brukspolicy. Automatisert håndheving er aktiv i nettskriveren, HTTP API og SMTP-innsending. Kontoer som sender markedsføring eller massepost, eller på annen måte misbruker sendingsinfrastruktur, kan bli begrenset, suspendert eller avsluttet.

Vi overvåker leverbarhetssignaler. Vedvarende avvisningsrater over 3 % eller klagerater over 0,1 % kan utløse en midlertidig sendepause eller manuell gjennomgang.

Se våre tjenestevilkår, personvernerklæring og GDPR-erklæring for fullstendig policyinformasjon.

Autentisering

Send din domene API-nøkkel på hver forespørsel:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternativt, bruk X-Api-Key: ubk_live_…. Nøkler lagres hash'et; tilbakekall eller roter fra Domenes dashbord.

Forespørselsinnhold

JSON med PascalCase-feltnavn (From, To, …). camelCase-aliaser aksepteres også.

FeltPåkrevdBeskrivelse
FromJaAvsender — din personlige postkasse på nøkkelens domene (primær eller alias). Delte køer er ikke gyldige avsendere.
ToJaMottaker(e) — streng, kommaseparert streng, eller array
SubjectJaEmnefelt
TextBodyEn av TextBody / HtmlBodyRen tekst-innhold
HtmlBodyEn av TextBody / HtmlBodyHTML-innhold
CcNeiKopi-mottakere
BccNeiBlindkopi-mottakere
ReplyToNeiSvar-til-adresse
TagNeiValgfritt metadata-tagg (lagres med sendingen)

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

Vellykket respons

HTTP 200 med JSON:

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

Feilresponser

Feil returnerer 4xx (eller 500 for uventede feil) med JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
FeilkodeBetydning
0Vellykket
10Manglende API-nøkkel
11Ugyldig eller tilbakekalt nøkkel, eller domene ikke verifisert for sending
300Valideringsfeil (manglende felt, ugyldig JSON, osv.)
403Fra-adresse ikke tillatt — må være din personlige postkasse på nøkkelens domene
406SES avviste meldingen

Eksempler

Erstatt you@yourdomain.com med din personlige postkasse på domenet og bruk din egen API-nøkkel.

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 i gang

  1. Opprett en Unbox-konto og legg til ditt eget domene.
  2. Fullfør alle DNS-verifiseringstrinn i Domener.
  3. Åpne Domener → ditt domene → API og generer en domenenøkkel.
  4. Send din første melding med eksemplene ovenfor.
Unbox — API-dokumentasjon | Unbox.im