This action is irreversible. Deleted records cannot be recovered.
Endpoint
Base URL
Authentication
Include your API key in the request header:Your API key for authentication
Path Parameters
The ID of the worklist containing the records to delete
Request Body
Email address of the administrator making the deletion request (must be registered in the project’s admin list)
Array of record IDs to delete (1-25 records maximum)
Request Example
Response
Success Response
Response Fields
Success message confirming the deletion operation
Error Response
Error Codes
Error Code | HTTP Status | Description |
---|---|---|
invalid_payload | 400 | Missing request payload or format error |
invalid_admin | 400 | Invalid admin account or admin not registered in the project |
invalid_record | 400 | One or more record IDs do not exist |
invalide_worklist | 400 | Invalid worklist ID |
invalid_project | 400 | Missing project ID or invalid API key |
Important Notes
Deletion Limitations:
- Maximum 25 records can be deleted per request
- Only records within the specified worklist can be deleted
- Deletion is permanent and cannot be undone
- Ensure you have the correct record IDs before proceeding
Best Practices:
- Verify record IDs exist before attempting deletion
- Use batch operations for multiple deletions to improve efficiency
- Keep a backup of important records before deletion
- Monitor the response for any partial failures
Batch Processing:
- The system processes all record IDs in a single request
- If some records fail to delete, the response will include detailed error information
- Partial failures are possible - some records may be deleted while others fail
Rate Limits
This endpoint follows the standard rate limiting policies. Each request can process up to 25 record deletions simultaneously.