---
title: "Set Onboarding Status for a candidate"
method: PUT
path: "/candidates/{id}/onboardingStatus"
tags: ["candidates"]
deprecated: true
---

# Set Onboarding Status for a candidate

`PUT /candidates/{id}/onboardingStatus`

## Request

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

> **Deprecated.**

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

## Request body

- OnboardingStatus
  - `onboardingStatus` 'READY_TO_ONBOARD' | 'ONBOARDING_SUCCESSFUL' | 'ONBOARDING_FAILED', required

## Response `204`

Onboarding status successfully updated.

## Other responses

- `403`: with codes: * **NO_ACCESS_TO_CANDIDATE** when Onboarding Status is not editable with assigned permissions.
- `404`: with codes: * **CANDIDATE_NOT_FOUND** when candidate not found, * **ONBOARDING_STATUS_NOT_ACTIVE** when Onboarding Status custom candidate property is not activated, * **CANDIDATE_FIELDS_FEATURE_MISSING** when Onboarding Status is not accessible. Required feature: 'Candidate Fields'.

---

[API](https://skmtc.dev/smartrecruiters/apis/candidates-api.md) - [All operations](https://skmtc.dev/smartrecruiters/apis/candidates-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrecruiters/apis/candidates-api/revisions/8fde9b33d46d?raw)