/candidates/:id/disqualify

Disqualifies a candidate. Required scope: w_candidates. Accessible with all token types.

post/candidates/{id}/disqualify

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/candidates/{id}/disqualify
  • Auth
    API key in header Authorization

Path parameters

idstring required

The candidate's id

Request body

member_idstring required

The id of the member performing the disqualification

disqualify_reason_idstring

The id of the disqualification reason as provided in GET /disqualification_reasons

disqualify_notestring

Add additional info regarding the disqualification here. (Max length 256 characters)

withdrewboolean

Indicates the disqualification category, if the candidate withdrew (true). or was rejected (false)

disqualification_reasonstring

** DEPRECATED ** A short description of why the candidate should be disqualified

Response

200

Changes

No recorded changes to this operation across all 2 revisions of this API.