---
title: "Update candidate properties values"
method: POST
path: "/0/candidates/{id}/properties"
tags: ["candidates"]
---

# Update candidate properties values

`POST /0/candidates/{id}/properties`

## Request

- Base URL: `https://api.taleez.com`
- URL: `https://api.taleez.com/0/candidates/{id}/properties`
- Auth: API key in header `X-taleez-api-secret`

🔑 You can access this if you have the 'candidate.properties.update' scope activated on your secret key.

## Path parameters

- `id` string, required

## Request body

- CandidatePropertyParameter[]
  - `id` integer, required: Property id
  - `value` string: Used only for property without choice. The value of the property for this candidate. For DATE property the format must be : yyyy-MM-dd
  - `choices` integer[]: Used only for property with choices : list of choice ids selected for this candidate. Empty list to remove all selected choices
  - `starValues` StarValue[]: Used only for property of type STAR
    - `id` integer: Question choice id
    - `value` integer: Rating value, between 0 and 5
  - `documentId` integer: Used only for property of type DOC : id of a document which already exist for this candidate to associate for the property. To get candidate documents or add a new document to a candidate, use /0/candidates/{id}/documents endpoints
  - `appendChoices` boolean: Used only for property that allow multiple choices (CHECkBOX, SELECTMUL..) : indicate if choice ids specified in 'choices' parameter has to be append to existing selected choices, or replace its. Default is false

## Response `200`

Properties have been updated

## Other responses

- `400`: Something's wrong with your request, additional info will be provided in error message

---

[API](https://skmtc.dev/taleez/apis/taleez-api.md) · [All operations](https://skmtc.dev/taleez/apis/taleez-api/llms.txt) · [OpenAPI document](https://skmtc.dev/taleez/apis/taleez-api/revisions/603f1750bc8f?raw)