Lire tous les réglages

GET /api/v1/settings Tous les réglages de l'organisation en une seule lecture : qui signe ses e-mails, comment se comporte l'inscription, et si elle peut envoyer tout court. Volontairement agrégé — un agent qui a besoin de six appels pour connaître l'état d'un compte en fera cinq et se trompera.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERAutorisé
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.

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/settings"

Réponse

  • 200 OK — l'appel a réussi.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

C'est effectiveSender qu'il faut vérifier, pas senderEmail. C'est l'adresse sous laquelle la prochaine campagne partira réellement, y compris l'adresse de repli utilisée tant qu'aucun domaine n'est vérifié.
ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.sending.senderEmailstring \null
data.sending.senderNamestring \null
data.sending.postalAddressstring \null
data.sending.effectiveSenderstring \null
data.optin.requiredbooleanSi un nouveau contact doit confirmer avant d'être abonné
data.optin.subjectstringObjet de l'e-mail de confirmation — la valeur par défaut s'il n'a jamais été personnalisé
data.optin.contentstringSon HTML, même règle
data.optin.customizedbooleanfalse signifie que les deux champs ci-dessus sont les valeurs par défaut du produit
data.readinessobjectLe même objet que celui renvoyé par GET /api/v1/me sous sending : ready, blockers, setup

Exemple de réponse

json
{
  "success": true,
  "data": {
    "sending": {
      "senderEmail": "hello@mail.example.com",
      "senderName": "Example",
      "postalAddress": "12 rue des Lilas, 59000 Lille",
      "effectiveSender": "Example <hello@mail.example.com>"
    },
    "optin": {"required": true, "subject": "Confirm your subscription", "content": "<html>…</html>", "customized": false},
    "readiness": {"ready": true, "blockers": [], "setup": {"status": "verified", "provisioning": "provisioned"}}
  }
}

Voir aussi