Documentos
Eliminar documento
Eliminar un documento que has subido, junto con sus resultados extraídos
DELETE
/
api
/
v1
/
documents
/
{id}
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
Elimina un documento que hayas subido con Subir documento. Úsalo cuando
hayas subido un archivo al perfil equivocado. Aniva elimina el archivo y todos los valores extraídos de él.
Los valores también desaparecen de la app de Aniva del miembro.
Requiere el permiso
documents_upload en el grupo de perfiles bajo el que se subió el documento.
A continuación, Aniva envía el webhook document.deleted a los endpoints que recibieron
el último evento de resultados del documento. La eliminación no se puede deshacer.
Solicitud
Parámetros de ruta
Respuesta
Si la solicitud tiene éxito, la API devuelve200 OK.
Respuestas de error
| Estado | Descripción |
|---|---|
400 | Formato de ID no válido. |
403 | Tu clave de API no tiene el permiso documents_upload. |
404 | Ningún documento subido bajo alguno de tus grupos de perfiles tiene este ID. |
500 | Error interno del servidor. |
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}
⌘I
curl --request DELETE \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"deleted": true
}