Eliminar un dominio

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ó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
domainIdstringObligatorio. 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 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 declaración ya no existe

Ejemplo de respuesta

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

Relacionado