Dar de baja un contacto

POST /api/v1/contacts/{contactId}/unsubscribe Da de baja el contacto. Idempotente: llamarlo sobre un contacto ya dado de baja no cambia nada y sigue respondiendo 200.

bash

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

Autorización

Rol en la organización	Este endpoint
`OWNER`	Permitido
`ADMIN`	Permitido
`MEMBER`	Rechazado — `403`

Una clave lleva el rol que su creador tiene en esta organización, nunca un rol sobre AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

Parámetro	Tipo	Descripción
`contactId`	string	Obligatorio. El contacto que pidió dejar de recibir

Ejemplo

bash

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

Respuesta

200 OK: la llamada se realizó correctamente.
401 Unauthorized: clave ausente o no válida, o su propietario salió de la organización.
403 Forbidden: el propietario de la clave es member de la organización, no admin.
404 Not Found: no existe ese recurso, o pertenece a otra organización. La API nunca confirma que un id existe a un llamante que no tiene derecho sobre él.
429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

El contacto, ahora unsubscribed. Idempotente: llamarlo dos veces no cambia nada.

Campo	Tipo	Descripción
`success`	boolean	Indica si la operación se realizó correctamente
`data.id`	string	Identificador del contacto
`data.email`	string	Su dirección: única dentro de su lista
`data.firstName` / `lastName`	string \	null
`data.status`	string	`pending`, `subscribed`, `unsubscribed`, `bounced`, `complained`
`data.listId`	string	La lista a la que pertenece: un contacto pertenece exactamente a una
`data.list`	object	`{id, name}` de esa lista
`data.tags`	array	`{id, name}` de cada etiqueta que lleva
`data.createdAt` / `updatedAt`	string	Fechas ISO

Ejemplo de respuesta

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"
  }
}