DELETE /api/v1/domains/{domainId}
Elimina la declaración. Requiere el rol Admin.
La identidad de envío subyacente se conserva: otra organización puede haber declarado el mismo dominio, y una identidad verificada es costosa de reconstruir.
Eliminar un dominio elimina aquello en lo que se apoyaban sus direcciones: una campaña cuyo remitente ya no está en un dominio verificado deja de salir, y el rechazo lo nombra.
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 |
|---|---|---|
domainId | string | Obligatorio. La declaración que se elimina |
Ejemplo
bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
"https://www.agentsmail.io/api/v1/domains/$DOMAIN_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 declaración ya no existe |
Ejemplo de respuesta
json
{"success": true, "data": {"deleted": true}}