POST /mailing/send-template
Mettez en file une nouvelle demande d'envoi à partir d'un modèle existant.
Vue d'ensemble
Utilisez cet endpoint pour envoyer un email avec un modèle stocké dans Mailiqo. La version du modèle sélectionnée pour l'envoi fournit l'objet, le corps HTML et le corps en texte brut. Les destinataires sont traités de la même façon que dans POST /mailing/send.
Les variables du modèle utilisent la syntaxe . Les variables absentes sont remplacées par une chaîne vide, et les variables qui n'apparaissent pas dans le modèle sont ignorées.
Endpoint
POST /v1/mailing/send-templatecurl -X POST https://api.mailiqo.com/v1/mailing/send-template \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"template_uuid": "7e9c6c60-8a98-4c10-9d5e-xxxxxxxx",
"from": "[email protected]",
"to": "[email protected]",
"variables": {"first_name": "Jane"}
}'Corps de la requête
Le corps de la requête doit être envoyé en JSON.
Champs obligatoires
| Champ | Type | Requis | Description |
|---|---|---|---|
template_uuid | string | Oui | UUID du modèle à utiliser. |
from | string (email) | Oui | Adresse email de l'expéditeur. |
to | mixed | Oui | Destinataires principaux. Voir le format des destinataires ci-dessous. |
Champs facultatifs
| Champ | Type | Requis | Description |
|---|---|---|---|
cc | mixed | Non | Destinataires en copie. |
bcc | mixed | Non | Destinataires en copie cachée. |
variables | object | Non | Valeurs utilisées pour remplacer les variables du modèle. |
attachments | array | Non | Liste des pièces jointes. |
force_validation | boolean | Non | Lance une nouvelle vérification de chaque destinataire pendant l'envoi, sans réutiliser les résultats précédents. Équivaut à validation.mode: "always", et consomme un crédit par destinataire vérifié |
validation | object | Non | Ajuste la validation pour cet envoi seulement. Voir Validation pour cet envoi |
Validation pour cet envoi
Fonctionne exactement comme dans POST /mailing/send. Par défaut, la configuration du domaine d'envoi s'applique ; l'objet validation la renforce pour cette requête seulement :
{
"template_uuid": "7e9c6c60-8a98-4c10-9d5e-xxxxxxxx",
"from": "[email protected]",
"to": "[email protected]",
"validation": {
"mode": "always",
"level": "restrictive",
"block": ["catch_all", "risky"]
}
}| Champ | Valeurs | Description |
|---|---|---|
mode | unknown_only, always | Quand la boîte mail du destinataire est sondée |
level | preventive, restrictive | Niveau d'exigence de la vérification |
block | liste parmi catch_all, risky, unknown | Résultats douteux que vous écartez pour cet envoi |
Un envoi ne peut que renforcer
L'ajustement n'assouplit jamais la configuration du domaine, et block ne fait qu'ajouter à ce que le domaine bloque déjà. C'est pourquoi mode n'accepte pas never. Une valeur non reconnue renvoie 400 avec le code 1419.
L'explication complète se trouve dans Validation des destinataires.
Format des destinataires
to, cc et bcc utilisent les mêmes formats que ceux documentés dans POST /mailing/send.
Format des variables
{
"first_name": "Jane",
"company_name": "Acme"
}Ces valeurs peuvent être utilisées par des variables telles que {{first_name}} et {{company_name}}.
Exemple de requête
{
"template_uuid": "7e9c6c60-8a98-4c10-9d5e-xxxxxxxx",
"from": "[email protected]",
"to": [
{
"name": "Jane Doe",
"email": "[email protected]"
}
],
"variables": {
"first_name": "Jane",
"company_name": "Acme"
},
"attachments": [
{
"filename": "invoice.pdf",
"content_base64": "JVBERi0xLjQKJ...",
"content_type": "application/pdf"
}
]
}Exemple de réponse réussie (status = success)
{
"status": "success",
"data": {
"uuid": "0c4ab8dc-0df4-4ef6-89ea-53ee4a8e1a3f",
"sent_to": [
{
"name": "Jane Doe",
"email": "[email protected]"
}
],
"rejected_recipients": []
}
}Exemple de réponse d'erreur
{
"status": "error",
"error": {
"code": "1416",
"message": "Email template not found.",
"details": {}
}
}Réponses HTTP
| Statut | Signification |
|---|---|
200 | Requête traitée. |
400 | Requête invalide ou erreur de validation. |
401 | Authentification échouée ou requête non autorisée. |
404 | Modèle introuvable. |
409 | Le modèle n'a aucune version publiée (1420). |
429 | Limite d'envoi atteinte (1421). Attendez le nombre de secondes indiqué dans l'en-tête Retry-After avant de renvoyer. Voir Limites d'envoi. |
500 | Erreur interne du serveur. |
Remarques
- Le modèle fournit l'objet et le contenu du corps.
- La livraison est asynchrone une fois la requête acceptée.
- Les destinataires acceptés et rejetés suivent le même format de réponse que
POST /mailing/send.
Endpoints associés
POST /mailing/send— envoyer sans modèleGET /mailing/email-request/{uuid}— statut de la demandeGET /mailing/email-message/{uuid}— statut et validation par destinataire
Voir aussi
- API d'envoi d'emails — le flux complet et les états de réponse
- Validation des destinataires — comment elle se configure et ce qui est vérifié
- API de validation d'emails — vérifier des adresses sans rien leur envoyer
