API reference
Set a decision
PUT
Records the hiring decision for a candidate and a job, replacing any earlier one. Repeating the same decision and note changes nothing. The change is recorded in the decision's history and announced as decision.updated.
Required scope: decisions:write.
Errors
- 400:
invalid_content_type,invalid_json,request_body_too_large,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
candidate_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 <= 200application/json- body
decision*stringThe hiring decision.
Value in
"advance""hold""not_progressing""hired"note?|Why, in your words. Send null or omit it for no note.
Success.
application/json- response
object*stringid*stringThe decision's ID.
candidate*The candidate the decision is about.
job*The job the decision is about.
decision*stringThe hiring decision.
Value in
"advance""hold""not_progressing""hired"note*|Why, in the decider's words.
reportId*|The report the decision was made from, when there was one.
decidedBy*Who made the decision.
decidedAt*stringWhen the decision was made.
Format
date-timeupdatedAt*stringWhen the decision last changed.
Format
date-time# 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 PUT "$PROBB_URL/api/v1/jobs/JOB_ID_VALUE/candidates/CANDIDATE_ID_VALUE/decision" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H 'Content-Type: application/json' \ --data-binary '{ "decision": "advance", "note": "Strong system design answers."}'Example Response
{ "object": "decision", "id": "string", "candidate": { "id": "string", "name": "string" }, "job": { "id": "string", "title": "string" }, "decision": "advance", "note": "string", "reportId": "string", "decidedBy": { "type": "user", "id": "string", "name": "string" }, "decidedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}