API-referentie
E-mail verzenden
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.
Overzicht
Genereer sleutels in Account → Domeinen → jouw domein → API nadat de DNS-verificatie is voltooid. Het volledige geheim wordt eenmalig getoond — bewaar het veilig. Optionele SMTP-referenties in hetzelfde Domeinen-paneel volgen dezelfde regels voor alleen transactionele e-mail.
Alleen transactionele e-mail
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.
Toegestane gebruiksdoeleinden
- Accountverificatie, wachtwoordherstel en beveiligingsmeldingen
- Bestelbevestigingen, bonnen, verzendupdates en betalingsmeldingen
- Meldingen geactiveerd door een specifieke gebruiker of systeemgebeurtenis
- Team- en werkruimteberichten (uitnodigingen, toewijzingen, interne meldingen)
Verboden gebruiksdoeleinden
- Nieuwsbrieven, promotiecampagnes of brede marketing
- Koude verkoop of e-mail naar gekochte, gescrape of niet-toestemmende lijsten
- Affiliate spam, phishing of misleidende inhoud
- Elke poging om ontvangercaps, snelheidslimieten of abonnementsquota's te omzeilen
Snelheids- en ontvangerlimieten
Om ontvangers en leverbaarheid te beschermen, is uitgaand API- en SMTP-verkeer onderworpen aan onderstaande limieten (naast het maandelijkse uitgaande quotum van je abonnement). Handhaving is actief op de webcomponist, HTTP API en SMTP-verzending. De webcomponist waarschuwt na 25 ontvangers per bericht en blokkeert verzendingen boven de 50.
| Limiet | Waarde |
|---|---|
| Ontvangers per bericht | Maximaal 50 in totaal (Aan + Cc + Bcc gecombineerd) |
| Unieke ontvangers per dag | Maximaal 1.000 per werkruimte |
| Verzendsnelheid | Maximaal 10 API- of SMTP-verzendingen per minuut per domein |
| Abonnementsuitgaand quotum | Maandelijkse verzendlimieten van je abonnement blijven van toepassing |
Deze regels maken deel uit van ons Acceptabele Gebruiksbeleid. Geautomatiseerde handhaving is actief op de webcomponist, HTTP API en SMTP-verzending. Accounts die marketing- of bulk-e-mail verzenden of op andere wijze de verzendinfrastructuur misbruiken, kunnen worden beperkt, opgeschort of beëindigd.
We monitoren leverbaarheidssignalen. Aanhoudende bouncepercentages boven 3% of klachtenpercentages boven 0,1% kunnen leiden tot een tijdelijke verzendpauze of handmatige controle.
Zie onze Servicevoorwaarden, Privacybeleid en GDPR-verklaring voor volledige beleidsdetails.
Authenticatie
Stuur je domein-API-sleutel bij elke aanvraag:
Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxxGebruik alternatief X-Api-Key: ubk_live_…. Sleutels worden gehasht opgeslagen; intrekken of roteren via het Domeinen-dashboard.
Aanvraagbody
JSON met PascalCase-veldnamen (From, To, …). camelCase-aliasen worden ook geaccepteerd.
| Veld | Vereist | Beschrijving |
|---|---|---|
From | Ja | Afzender — jouw persoonlijke mailbox op het domein van de sleutel (primair of alias). Gedeelde wachtrijen zijn geen geldige afzenders. |
To | Ja | Ontvanger(s) — string, door komma's gescheiden string, of array |
Subject | Ja | Onderwerpregel |
TextBody | Een van TextBody / HtmlBody | Platte tekst body |
HtmlBody | Een van TextBody / HtmlBody | HTML-body |
Cc | Nee | CC-ontvangers |
Bcc | Nee | BCC-ontvangers |
ReplyTo | Nee | Reply-To-adres |
Tag | Nee | Optionele metadata-tag (opgeslagen bij de verzending) |
Voorbeeld
{
"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"
}Succesvolle respons
HTTP 200 met JSON:
{
"ErrorCode": 0,
"Message": "OK",
"MessageID": "0100018…-000000-…",
"SubmittedAt": "2026-06-23T12:00:00.000Z",
"To": "user@example.com"
}Foutmeldingen
Fouten retourneren 4xx (of 500 bij onverwachte fouten) met JSON:
{
"ErrorCode": 300,
"Message": "TextBody or HtmlBody is required."
}| Foutcode | Betekenis |
|---|---|
0 | Succes |
10 | API-sleutel ontbreekt |
11 | Ongeldige of ingetrokken sleutel, of domein niet geverifieerd voor verzending |
300 | Validatiefout (ontbrekende velden, ongeldige JSON, enz.) |
403 | Afzenderadres niet toegestaan — moet uw persoonlijke mailbox op het domein van de sleutel zijn |
406 | SES heeft het bericht geweigerd |
Voorbeelden
Vervang you@yourdomain.com door uw persoonlijke mailbox op het domein en gebruik uw eigen API-sleutel.
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"
}'Aan de slag
- Maak een Unbox-account aan en voeg uw eigen domein toe.
- Voltooi alle DNS-verificatiestappen in Domeinen.
- Open Domeinen → uw domein → API en genereer een domeinsleutel.
- Verzend uw eerste bericht met de bovenstaande voorbeelden.