DELETE /api/v1/settings/identities/{identityId}
Quita una dirección de la libreta. Requiere el rol Admin.
Dos rechazos que conviene conocer antes de llamar: eliminar la dirección predeterminada mientras quedan otras direcciones (promueve otra primero), y eliminar una dirección que una campaña referencia: las campañas se nombran en el error, sea cual sea su estado.
Eliminar la última dirección está permitido: una organización con la libreta vacía vuelve a la dirección compartida de AgentsMail, siempre que no haya ningún dominio verificado.
Autorización
| Rol en la organización | Este endpoint |
|---|---|
OWNER | Permitido |
ADMIN | Permitido |
MEMBER | Rechazado — 403 |
Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
identityId | string | Obligatorio. La dirección que se elimina |
Ejemplo
bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
"https://www.agentsmail.io/api/v1/settings/identities/$IDENTITY_ID"Respuesta
200 OK: la llamada tuvo éxito.401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.403 Forbidden: el propietario de la clave esmemberde la organización, noadmin.404 Not Found: no existe ese recurso, o pertenece a otra organización. La API nunca confirma que un id existe a quien no tiene derecho sobre él.429 Too Many Requests: más de 120 peticiones en un minuto para esta clave.
Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
success | boolean | Indica si la operación tuvo éxito |
data.deleted | boolean | true cuando la dirección ya no existe |
Ejemplo de respuesta
json
{"success": true, "data": {"deleted": true}}