Tester l'e-mail de confirmation

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'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 403
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Corps de la requête

ChampTypeObligatoireDescription
emailstringouiOù livrer le test
subjectstringnonEssayer un objet sans l'enregistrer
contentstringnonEssayer 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é ; details porte 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é est member de l'organisation, pas admin.
  • 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).
ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.statusstringsent, ou la raison pour laquelle il n'est pas parti

Exemple de réponse

json
{"success": true, "data": {"status": "sent"}}

Voir aussi