Soft-deletes a candidate by ID. Deleted candidates are not permanently removed but are hidden from list operations.
Overview
The delete candidate endpoint performs a soft delete, meaning the candidate is marked as deleted but not permanently removed from the system. This preserves data integrity and maintains relationships with existing interviews for audit purposes.
Use Cases
- Remove Duplicates: Clean up duplicate candidate entries
- GDPR Compliance: Handle data deletion requests (soft delete for audit)
- Pipeline Cleanup: Remove candidates who are no longer in consideration
- Data Management: Maintain a clean candidate database
Soft Delete Behavior
Deleted candidates are soft-deleted, meaning they are hidden from list and get operations but remain in the database for audit purposes. They cannot be used for new interviews.
Impact on Existing Interviews
Deleting a candidate does not affect existing interviews. Those interviews retain their association with the candidate for historical accuracy. However, you cannot create new interviews for a deleted candidate.
GDPR Considerations
For GDPR “right to be forgotten” requests requiring permanent deletion, contact support. Soft deletion maintains audit trails while removing candidates from active operations.
Company Isolation
You can only delete candidates that are associated with jobs in your API key’s company. The API validates company ownership before allowing deletion.
Error Scenarios
- 404 Not Found: Candidate doesn’t exist or has already been deleted
- 403 Forbidden: Candidate’s job belongs to a different company
API key for authentication using Bearer scheme
The response is of type boolean.