---
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`

> **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.net/smartrecruiters/apis/apply-api.md) · [All operations](https://skmtc.net/smartrecruiters/apis/apply-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartrecruiters/apply-api/versions/449bdc2516c9/schema)