POST /api/v1/settings/optin/test-send
Envoie l'e-mail de confirmation à l'adresse de votre choix, avec un lien qui ne confirme personne. Rôle admin requis.
Un test est un envoi réel. Il passe par les mêmes garde-fous qu'une campagne et compte dans votre quota d'envoi. Il n'écrit aucune statistique.
Autorisation
| Rôle dans l'organisation | Cet endpoint |
|---|---|
OWNER | Autorisé |
ADMIN | Autorisé |
MEMBER | Refusé — 403 |
Corps de la requête
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
email | string | oui | Où livrer le test |
subject | string | non | Essayer un objet sans l'enregistrer |
content | string | non | Essayer un corps HTML sans l'enregistrer |
Exemple
bash
curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "you@example.com"}' \
"https://www.agentsmail.io/api/v1/settings/optin/test-send"Réponse
200 OK— l'appel a réussi.400 Bad Request— la validation a échoué ;detailsporte les erreurs champ par champ.401 Unauthorized— clé absente ou invalide, ou son propriétaire a quitté l'organisation.403 Forbidden— le propriétaire de la clé estmemberde l'organisation, pasadmin.429 Too Many Requests— plus de 120 requêtes en une minute pour cette clé.
Champs de la réponse
Statuts de refus :blocked (envoi en pause sur tout AgentsMail), not_allowed (organisation non autorisée, ou domaine non vérifié), skipped (rien à envoyer).
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si l'opération a réussi |
data.status | string | sent, ou la raison pour laquelle il n'est pas parti |
Exemple de réponse
json
{"success": true, "data": {"status": "sent"}}