SMsmartrecruiters
candidates

Set Onboarding Status for a candidate

Set Onboarding Status for a candidate. Please use PUT /candidates/{id}/jobs/{jobId}/onboardingStatus instead.

put/candidates/{id}/onboardingStatus

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/candidates/{id}/onboardingStatus
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: candidates_manage

Request body

onboardingStatus'READY_TO_ONBOARD' | 'ONBOARDING_SUCCESSFUL' | 'ONBOARDING_FAILED' required

Response

Onboarding status successfully updated.

Changes

No recorded changes to this operation across all 1 revision of this API.