Référence API
Envoyer un 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.
Vue d'ensemble
Générez des clés dans Compte → Domaines → votre domaine → API après la vérification DNS. Le secret complet est affiché une fois — conservez-le en sécurité. Les identifiants SMTP optionnels dans le même panneau Domaines suivent les mêmes règles transactionnelles uniquement.
E-mail transactionnel uniquement
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.
Utilisations autorisées
- Vérification de compte, réinitialisation de mot de passe et alertes de sécurité
- Confirmations de commande, reçus, mises à jour d'expédition et avis de paiement
- Notifications déclenchées par un événement utilisateur ou système spécifique
- Messages d'équipe et d'espace de travail (invitations, affectations, alertes internes)
Utilisations interdites
- Newsletters, campagnes promotionnelles ou marketing diffusé
- Prospection à froid ou envoi à des listes achetées, scrapées ou non consentantes
- Spam d'affiliation, hameçonnage ou contenu trompeur
- Toute tentative de contourner les plafonds de destinataires, les limites de débit ou les quotas de forfait
Limites de débit et de destinataires
Pour protéger les destinataires et la délivrabilité, le trafic sortant de l'API et SMTP est soumis aux limites ci-dessous (en plus du quota mensuel sortant de votre forfait). L'application est en vigueur sur le compositeur web, l'API HTTP et la soumission SMTP. Le compositeur web avertit après 25 destinataires par message et bloque les envois au-delà de 50.
| Limite | Valeur |
|---|---|
| Destinataires par message | Jusqu'à 50 au total (À + Cc + Cci combinés) |
| Destinataires uniques par jour | Jusqu'à 1 000 par espace de travail |
| Taux de requêtes d'envoi | Jusqu'à 10 soumissions API ou SMTP par minute par domaine |
| Quota sortant du forfait | Les limites d'envoi mensuelles de votre abonnement s'appliquent toujours |
Ces règles font partie de notre politique d'utilisation acceptable. L'application automatisée est en vigueur sur le compositeur web, l'API HTTP et la soumission SMTP. Les comptes qui envoient des courriers marketing ou en masse, ou qui abusent de l'infrastructure d'envoi, peuvent être limités, suspendus ou résiliés.
Nous surveillons les signaux de délivrabilité. Des taux de rebond soutenus supérieurs à 3 % ou des taux de plainte supérieurs à 0,1 % peuvent déclencher une pause temporaire des envois ou une révision manuelle.
Consultez nos Conditions d'utilisation, notre Politique de confidentialité et notre Déclaration RGPD pour tous les détails de la politique.
Authentification
Envoyez votre clé API de domaine sur chaque requête :
Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxxAlternativement, utilisez X-Api-Key: ubk_live_…. Les clés sont stockées hachées ; révoquez ou renouvelez depuis le tableau de bord des domaines.
Corps de la requête
JSON avec des noms de champs en PascalCase (From, To, …). Les alias camelCase sont également acceptés.
| Champ | Requis | Description |
|---|---|---|
From | Oui | Expéditeur — votre boîte aux lettres personnelle sur le domaine de la clé (principale ou alias). Les files d'attente partagées ne sont pas des expéditeurs valides. |
To | Oui | Destinataire(s) — chaîne, chaîne séparée par des virgules ou tableau |
Subject | Oui | Objet |
TextBody | Un de TextBody / HtmlBody | Corps en texte brut |
HtmlBody | Un de TextBody / HtmlBody | Corps HTML |
Cc | Non | Destinataires en copie |
Bcc | Non | Destinataires en copie cachée |
ReplyTo | Non | Adresse de réponse |
Tag | Non | Balise de métadonnées facultative (stockée avec l'envoi) |
Exemple
{
"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"
}Réponse de succès
HTTP 200 avec JSON :
{
"ErrorCode": 0,
"Message": "OK",
"MessageID": "0100018…-000000-…",
"SubmittedAt": "2026-06-23T12:00:00.000Z",
"To": "user@example.com"
}Réponses d'erreur
Les erreurs renvoient 4xx (ou 500 pour les échecs inattendus) avec JSON :
{
"ErrorCode": 300,
"Message": "TextBody or HtmlBody is required."
}| Code d'erreur | Signification |
|---|---|
0 | Succès |
10 | Clé API manquante |
11 | Clé invalide ou révoquée, ou domaine non vérifié pour l'envoi |
300 | Erreur de validation (champs manquants, JSON invalide, etc.) |
403 | Adresse d'expéditeur non autorisée — doit être votre boîte aux lettres personnelle sur le domaine de la clé |
406 | SES a rejeté le message |
Exemples
Remplacez you@yourdomain.com par votre boîte aux lettres personnelle sur le domaine et utilisez votre propre clé API.
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"
}'Pour commencer
- Créez un compte Unbox et ajoutez votre domaine personnalisé.
- Effectuez toutes les étapes de vérification DNS dans la section Domaines.
- Ouvrez Domaines → votre domaine → API et générez une clé de domaine.
- Envoyez votre premier message avec les exemples ci-dessus.