Retirer une adresse

DELETE /api/v1/settings/identities/{identityId} Retire une adresse du carnet. Rôle admin requis. Deux refus à connaître avant d'appeler : supprimer l'adresse par défaut alors que d'autres adresses restent (promouvez-en d'abord une autre), et supprimer une adresse qu'une campagne référence — les campagnes sont nommées dans l'erreur, quel que soit leur statut. Supprimer la dernière adresse est autorisé : une organisation au carnet vide revient à l'adresse partagée d'AgentsMail, tant qu'aucun domaine n'est vérifié.

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.

Paramètres de chemin

ParamètreTypeDescription
identityIdstringObligatoire. L'adresse à retirer

Exemple

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

Réponse

  • 200 OK — l'appel a réussi.
  • 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.
  • 404 Not Found — aucune ressource de ce type, ou elle appartient à une autre organisation. L'API ne confirme jamais qu'un identifiant existe à un appelant qui n'y a pas droit.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.deletedbooleantrue quand l'adresse a disparu

Exemple de réponse

json
{"success": true, "data": {"deleted": true}}

Voir aussi