Dokumente
Dokument löschen
Ein von dir hochgeladenes Dokument zusammen mit den extrahierten Ergebnissen löschen
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
}
Lösche ein Dokument, das du mit Dokument hochladen hochgeladen
hast. Nutze das, wenn du eine Datei ins falsche Profil hochgeladen hast. Aniva löscht die Datei und
alle daraus extrahierten Werte. Die Werte verschwinden auch aus der Aniva-App des Mitglieds.
Erfordert den Scope
documents_upload für die Profilgruppe, unter der das Dokument hochgeladen wurde.
Aniva sendet anschließend den Webhook document.deleted an die Endpunkte,
die das letzte Ergebnis-Event des Dokuments erhalten haben. Eine Löschung kann nicht rückgängig
gemacht werden.
Anfrage
Pfadparameter
Antwort
Bei Erfolg gibt die API200 OK zurück.
Fehlerantworten
| Status | Beschreibung |
|---|---|
400 | Ungültiges ID-Format. |
403 | Deinem API-Schlüssel fehlt der Scope documents_upload. |
404 | Kein Dokument, das unter einer deiner Profilgruppen hochgeladen wurde, hat diese ID. |
500 | Interner Serverfehler. |
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
}