API reference
Clear a decision
DELETE
Returns the candidate to undecided for this job. The change stays in the history and is announced as decision.cleared. Answers decision_not_found when there is nothing to clear.
Required scope: decisions:write.
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
candidate_not_found,decision_not_found,job_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>jobId*stringThe job's ID.
Length
1 <= length <= 200candidateId*stringThe candidate's ID.
Length
1 <= length <= 200Success.
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/jobs/JOB_ID_VALUE/candidates/CANDIDATE_ID_VALUE/decision" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "decision", "id": "string", "deleted": true}