Remove a candidate from a flow
DELETE/v1/flows/:flow_id/candidates/:candidate_id
Takes the candidate out of the flow along with what it scheduled for them. A candidate the flow has already sent to cannot be removed: stop them instead.
Request
Responses
- 204
- 401
- 403
- 404
- 422
Candidate removed
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_candidate_not_removable- the flow has already sent to this candidateerr_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