candidates

Update candidate properties values

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

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

Path parameters

idstring required

Id of the candidate

Request body

idinteger required

Property id

valuestring

Used only for property without choice. The value of the property for this candidate. For DATE property the format must be : yyyy-MM-dd

choicesinteger[]

Used only for property with choices : list of choice ids selected for this candidate. Empty list to remove all selected choices

documentIdinteger

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

appendChoicesboolean

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

Example request

[
  {
    "id": 12785,
    "value": "My new value",
    "choices": [
      5487,
      9873
    ],
    "starValues": [
      {
        "id": 46577,
        "value": 3
      }
    ],
    "documentId": 549672
  }
]

Response

Properties have been updated

Changes

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