Eliminar un medio

DELETE /api/v1/media Elimina un medio de la biblioteca. Un medio no tiene id propio: su identidad es el path que devuelven Subir un medio y Listar medios, por eso aquí viaja como parámetro de consulta y no como segmento de la ruta.

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 consulta

ParámetroTipoDescripción
pathstringObligatorio. El path del medio, tal como lo devuelven la subida o el listado

Ejemplo

bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
  --data-urlencode "path=organizations/7c2e…/media/newsletter/logo-1703123456789.jpg" \
  -G "https://www.agentsmail.io/api/v1/media"

Respuesta

  • 200 OK: la llamada tuvo éxito.
  • 400 Bad Request: falta el parámetro de consulta path.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 403 Forbidden: quien llama es un miembro legítimo, pero su rol es insuficiente.
  • 404 Not Found: la ruta no pertenece a la organización de la clave. La API nunca confirma que una ruta existe a quien no tiene derecho sobre ella.

Campos de la respuesta

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

Ejemplo de respuesta

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

Notas

  • Eliminar es definitivo: no hay papelera ni recuperación.
  • Un medio todavía referenciado en el HTML de una plantilla o una campaña se elimina igualmente: la referencia no se comprueba, y la etiqueta <img> simplemente se romperá en las aperturas futuras.

Relacionado