Update Job Applicant Status

This API allows you to update an applicant's status in your Cornerstone Recruiting portal.

Localization

The following request body fields are localized. The API considers the language of the user associated with the OAuth 2.0 application to determine the locale for these fields.

Localized Request Parameters:

  • Status
  • Disposition

If the value included in the request body does not match a localized value defined in your Cornerstone portal, the API will fall back on the default language of the portal to identify the value you sent.

To understand this localization logic better, let's consider an example. Let's assume the following are true in your Cornerstone portal:

  • The language of the user acquiring the session token is defined as French (fr-FR)
  • The French value for applicant status of 'Interview' is set as 'Entrevue'
  • The default language in your portal is defined as English (US) (en-US)

With this setup, the following three outcomes are possible:

  • Scenario 1: If you send Status=Entrevue in your API request body, the API will look for the localized applicant status values in French. Since a matching localized value of 'Entrevue' is found, the API will return a success response.
  • Scenario 2: If you send Status=Interviewer in your API request body, the API will look for the localized applicant status values in French. A matching localized value of 'Interviewer' is not found. The API then looks for the value of 'Interviewer' to be defined as an applicant status in English (US), the portal's default language. The API does not find that either because the English (US) value is defined as 'Interview'. This causes the API to return an error in the response.
  • Scenario 3: If you send Status=Interview in your API query parameter, the API will look for the localized applicant status values in French. A matching localized value of 'Interview' is not found. The API then looks for the value of 'Interview' to be defined as an applicant status in English (US), the portal's default language. The API does find it this time and returns a success response.

Permission Required: Applicants: Status Change

OAuth 2.0 Scope: jobapplicant:update

Error Descriptions

Handled Error List

Error TypesError Message
JobRequisitionIdInvalid Requisition Id.
StatusInvalid status.
DispositionDisposition is mandatory when status is closed.
DispositionInvalid Disposition
UserIdInvalid userid.
UsernameInvalid Username.
JobApplicantIdNo jobapplicant found.
JobApplicantIdInvalid jobapplicant.