Désabonner un contact

POST /api/v1/contacts/{contactId}/unsubscribe Désabonne le contact. Idempotent : l'appeler sur un contact déjà désabonné ne change rien et répond quand même 200.

bash

curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/contacts/$CONTACT_ID/unsubscribe"

Autorisation

Rôle dans l'organisation	Cet endpoint
`OWNER`	Autorisé
`ADMIN`	Autorisé
`MEMBER`	Refusé — `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ètre	Type	Description
`contactId`	string	Obligatoire. Le contact qui a demandé à arrêter

Exemple

bash

curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/contacts/$CONTACT_ID/unsubscribe"

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 — ressource inexistante, 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

Le contact, désormais unsubscribed. Idempotent : l'appeler deux fois ne change rien.

Champ	Type	Description
`success`	boolean	Indique si l'opération a réussi
`data.id`	string	Identifiant du contact
`data.email`	string	Son adresse — unique au sein de sa liste
`data.firstName` / `lastName`	string \	null
`data.status`	string	`pending`, `subscribed`, `unsubscribed`, `bounced`, `complained`
`data.listId`	string	La liste à laquelle il appartient — un contact appartient à une seule liste
`data.list`	object	`{id, name}` de cette liste
`data.tags`	array	`{id, name}` de chaque tag porté
`data.createdAt` / `updatedAt`	string	Dates ISO

Exemple de réponse

json

{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "email": "ada@example.com",
    "firstName` / `lastName": "value",
    "status": "subscribed",
    "listId": "0b7c51e8",
    "list": {
      "id": "0b7c51e8",
      "name": "Newsletter"
    },
    "tags": [
      {
        "id": "7c2ef4b1",
        "name": "vip"
      }
    ],
    "createdAt` / `updatedAt": "value"
  }
}