Courriels
Endpoints pour envoyer des courriels système et transactionnels. Module requis : MaCarteDeMembre.
Tous les endpoints de cette section retournent 204 No Content en cas de succès.
Renvoyer la dernière carte de membre
POST /b2b/v1/courriel/EnvoyerDerniereCarteMembre
Corps de la requête
{
"idExterneEmploye": "EMP-001",
"courriel": "alice@example.com"
}
L'adresse doit correspondre au courriel principal ou alternatif de l'employé.
Erreurs possibles
| Code | HTTP | Signification |
|---|---|---|
Employe.NotFound | 404 | L'employé n'existe pas |
Courriel.NotAssociatedWithEmployee | 400 | L'adresse ne correspond à aucun courriel de l'employé |
Courriel.BadEmailAddress | 400 | Adresse mal formée |
Envoyer un formulaire
POST /b2b/v1/courriel/EnvoyerFormulaire
Envoie le courriel contenant le lien personnalisé vers un formulaire.
Corps de la requête
{
"idExterneEmploye": "EMP-001",
"courriel": "alice@example.com",
"idFormulaire": 42
}
Erreurs possibles
| Code | HTTP | Signification |
|---|---|---|
Formulaire.NotFound | 404 | Le formulaire n'existe pas |
Formulaire.TemplateEmpty | 400 | Pas de template courriel configuré |
Formulaire.DoitEtrePersonnalise | 400 | Le formulaire doit être de type personnalisé |
Variantes par emploi
Pour les membres multi-employeurs, deux variantes ciblent un emploi spécifique :
POST /b2b/v1/courriel/EnvoyerDerniereCarteMembrePourEmploi
POST /b2b/v1/courriel/EnvoyerFormulairePourEmploi
Corps de la requête
{
"idExterneEmploi": "EMPLOI-001",
"courriel": "alice@example.com"
}
(idFormulaire requis pour la variante formulaire.)
Envoyer un courriel transactionnel
POST /b2b/v1/courriel/EnvoyerCourrielTransactionnel
Envoie un courriel arbitraire via le fournisseur configuré ou un fournisseur spécifique.
Corps de la requête
{
"destinataire": "alice@example.com",
"sujet": "Confirmation",
"contenu": "<p>Bonjour Alice,</p><p>Votre demande a été reçue.</p>",
"estHtml": true,
"replyTo": "noreply@syndicat.example.com",
"omettrePiedDePage": false,
"fournisseur": null
}
Erreurs possibles
| Code | HTTP | Signification |
|---|---|---|
Courriel.RateLimitExceeded | 500 | Limite d'envoi atteinte — réessayez plus tard |
Courriel.ContentTooLarge | 400 | Contenu dépasse la limite serveur |
Courriel.BadEmailAddress | 400 | destinataire mal formé |
Voir aussi
ICourrielClient— client SDK .NET