API reference
Delete a candidate
DELETE
Erases the candidate. By default their reports, interviews and decisions are deleted too, which also needs the reports:write scope when the candidate has reports; credits are never refunded. Send keepReports=true to keep the reports and detach them from the candidate, which needs only candidates:write. A key acts as its owner, so a member can delete only reports they created (permission_denied otherwise); admins can delete any.
Required scope: candidates:write.
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope,permission_denied - 404:
candidate_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe candidate's ID.
Length
1 <= length <= 200keepReports?stringtrue keeps the candidate's reports and detaches them. By default they are deleted with their interviews and decisions, which also needs the reports:write scope.
Default
"false"Value in
"true""false"Success.
application/json- response
object*stringid*stringdeleted*boolean# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X DELETE "$PROBB_URL/api/v1/candidates/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "candidate", "id": "string", "deleted": true}