API Reference
API Reference

/candidates/:id/disqualify

post
https://{subdomain}.workable.com/spi/v3/candidates//disqualify

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

A complete request would be:

{ 
  "member_id": "13e0eb0e", 
  "disqualification_reason": "Very tardy" 
}
Path Params
string
required

The candidate's id

Body Params
string
required

The id of the member performing the disqualification

string

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

string

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

boolean

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

string

DEPRECATED A short description of why the candidate should be disqualified

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json

Updated about 1 year ago