Restart a failed candidate
POST/v1/flows/:flow_id/candidates/:candidate_id/restart
Retries the step the system stopped on, for a candidate the system paused. Fix what caused the failure first, such as the candidate's email address.
Request
Responses
- 200
- 401
- 403
- 404
- 422
Candidate restarted
Missing or invalid bearer token.
The public API is not enabled for this account (err_feature_not_enabled), the acting user is not allowed to edit this flow, or the API key lacks the flows:write scope (err_insufficient_scope).
Flow not found (err_flow_not_found), or the candidate is not in the flow (err_candidate_not_in_flow).
Validation failed. Error codes:
err_flow_not_active- the flow is not activeerr_flow_candidate_not_failed- nothing is halted for this candidateerr_flow_candidate_awaiting_ai_review- the candidate is waiting on an AI message being reviewederr_candidate_email_required- the candidate has no email address to send toerr_candidate_has_application_for_job- the candidate already has an application in the flow's joberr_on_behalf_of_not_allowed- a personal access token passed another user's IDerr_user_not_found-on_behalf_ofis not an active user in the accounterr_on_behalf_of_forbidden- that user is not allowed to perform this action