---
title: "Anonymize candidates"
method: PATCH
path: "/v3/candidates/{id}/anonymize"
tags: ["Candidates"]
---

# Anonymize candidates

`PATCH /v3/candidates/{id}/anonymize`

## Request

- Base URL: `https://harvest.greenhouse.io`
- URL: `https://harvest.greenhouse.io/v3/candidates/{id}/anonymize`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://auth.greenhouse.io/authorize`
    - Client credentials
    - Token URL: `https://auth.greenhouse.io/token` scopes: `harvest:candidates:anonymize`
  - HTTP bearer

Anonymize selected categories of personally identifiable data on a candidate (for GDPR, CCPA, or other right-to-be-forgotten requests). The `fields` array selects which data groups to scrub — see the schema enum for the full set (e.g. `full_name`, `email_addresses`, `phone_numbers`, `attachments`, `notes`, `scorecards_and_interviews`). Anonymization is irreversible and runs asynchronously when the selected scope is large; the candidate's hiring activity remains intact for reporting.

## Path parameters

- `id` integer, required

## Request body

- object
  - `fields` string[], required

## Response `200`

Successful

- object
  - `id` integer
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `first_name` string, nullable
  - `last_name` string, nullable
  - `preferred_name` string, nullable: Preferred or chosen name the candidate goes by, when different from their legal first name.
  - `company` string, nullable: Candidate's current company, as entered on their profile.
  - `title` string, nullable: Candidate's current job title, as entered on their profile.
  - `last_activity_at` string, date-time, nullable: Timestamp of the most recent activity on any of the candidate's applications (notes, emails, stage changes, etc.), in ISO 8601.
  - `private` boolean, nullable: If true, the candidate is restricted to users with `View Private Candidates` access. Defaults to `false`.
  - `can_email` boolean: Whether this candidate has consented to receive email communication from your organization.
  - `time_zone` string, nullable: Candidate's time zone as a Rails-style identifier (for example `Eastern Time (US & Canada)`).
  - `tags` string[]: Candidate tag names applied to this candidate within your organization.
  - `linked_user_ids` integer[]: Ids of Greenhouse users linked to this candidate (employees represented by both a user record and a candidate record).
  - `phone_numbers` object[]: Phone numbers on the candidate's profile. Each entry pairs the `value` with a `type` such as `mobile`, `home`, `work`, `skype`, or `other`. Ordered by type — `home`, `work`, `mobile`, `skype`, then `other` — and oldest first within a type.
    - `value` string
    - `type` string
  - `addresses` object[]: Postal addresses on the candidate's profile. Each entry pairs the `value` with a `type` such as `home`, `work`, or `other`. Ordered oldest first.
    - `value` string
    - `type` string
  - `email_addresses` object[]: Email addresses on the candidate's profile. Each entry pairs the `value` with a `type` such as `personal`, `work`, or `other`. Ordered by most recently updated, and oldest first among entries last updated at the same time.
    - `value` string
    - `type` string
  - `website_addresses` object[]: Personal websites or portfolio URLs on the candidate's profile. Each entry pairs the `value` with a `type` such as `personal`, `company`, `portfolio`, `blog`, or `other`. Ordered oldest first.
    - `value` string
    - `type` string
  - `social_media_addresses` object[]: Social media handles or URLs on the candidate's profile. Social entries are untyped — only the `value` is returned. Ordered oldest first.
    - `value` string
  - `custom_fields` object, nullable

## Other responses

- `202`: Accepted
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Content

---

[API](https://skmtc.dev/greenhouse/apis/harvest-api.md) - [All operations](https://skmtc.dev/greenhouse/apis/harvest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/greenhouse/apis/harvest-api/revisions/822822e3f771?raw)