cURL
curl --request POST \ --url https://api.velt.dev/v2/commentannotations/delete \ --header 'Content-Type: application/json' \ --header 'x-velt-api-key: <x-velt-api-key>' \ --header 'x-velt-auth-token: <x-velt-auth-token>' \ --data '{ "data": { "organizationId": "<string>", "documentId": "<string>", "locationIds": [ "<string>" ], "annotationIds": [ "<string>" ], "userIds": [ "<string>" ] } }'
{ "result": { "status": "success", "message": "Annotations deleted successfully.", "data": { "yourAnnotationId": { "success": true, "id": "yourAnnotationId", "message": "Deleted Successfully" } } } }
POST https://api.velt.dev/v2/commentannotations/delete
Show properties
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId" } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "locationIds": [ "locationx" ] } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "locationIds": [ "locationx" ], "userIds": [ "yourUserId" ] } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "userIds": [ "yourUserId" ] } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "annotationIds": [ "yourAnnotationId1", "yourAnnotationId2" ] } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "locationIds": [ "locationx" ], "annotationIds": [ "yourAnnotationId1", "yourAnnotationId2" ] } }
{ "data": { "documentId": "yourDocumentId" } }
{ "data": { "documentId": "yourDocumentId", "locationIds": [ "locationx" ] } }
{ "data": { "documentId": "yourDocumentId", "userIds": [ "yourUserId" ] } }
{ "data": { "documentId": "yourDocumentId", "annotationIds": [ "yourAnnotationId1", "yourAnnotationId2" ] } }
{ "data": { "documentId": "yourDocumentId", "locationIds": [ "locationx" ], "userIds": [ "yourUserId" ] } }
{ "data": { "documentId": "yourDocumentId", "locationIds": [ "locationx" ], "annotationIds": [ "yourAnnotationId1", "yourAnnotationId2" ] } }
{ "result": { "status": "success", "message": "Annotations deleted successfully.", "data": { "yourAnnotationId1": { "success": true, "id": "yourAnnotationId", "message": "Deleted Successfully" }, "yourAnnotationId2": { "success": false, "id": "yourAnnotationId2", "message": "Annotation not found." } } } }
{ "error": { "message": "ERROR_MESSAGE", "status": "INVALID_ARGUMENT" } }
Was this page helpful?