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'organisation | Cet endpoint |
|---|---|
OWNER | Autorisé |
ADMIN | Autorisé |
MEMBER | Refusé — 403 |
Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
identityId | string | Obligatoire. 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é estmemberde l'organisation, pasadmin.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
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si l'opération a réussi |
data.deleted | boolean | true quand l'adresse a disparu |
Exemple de réponse
json
{"success": true, "data": {"deleted": true}}