Eliminar una dirección

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ónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERRechazado — 403
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

ParámetroTipoDescripción
identityIdstringObligatorio. 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 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 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

CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data.deletedbooleantrue cuando la dirección ya no existe

Ejemplo de respuesta

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

Relacionado