Documenten
Document verwijderen
Verwijder een document dat je hebt geüpload, samen met de geëxtraheerde resultaten
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
}
Verwijder een document dat je hebt geüpload met Document uploaden. Gebruik dit wanneer
je een bestand naar het verkeerde profiel hebt geüpload. Aniva verwijdert het bestand en elke waarde die eruit is gehaald.
De waarden verdwijnen ook uit de Aniva-app van het lid.
Vereist de
documents_upload-scope voor de profielgroep waaronder het document is geüpload.
Aniva stuurt daarna de document.deleted-webhook naar de endpoints die
het laatste resultaten-event van het document hebben ontvangen. Verwijderen kan niet ongedaan worden gemaakt.
Verzoek
Padparameters
Respons
Bij succes retourneert de API200 OK.
Foutresponsen
| Status | Beschrijving |
|---|---|
400 | Ongeldig ID-formaat. |
403 | Je API-sleutel mist de documents_upload-scope. |
404 | Er is geen document met dit ID geüpload onder een van jouw profielgroepen. |
500 | Interne serverfout. |
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
}