candidates
Add/update candidate property value
Please use PUT /candidates/{id}/jobs/{jobId}/properties instead. Set a candidate property value for the candidate. Below you can find a list of value examples, dependent on different candidate property types.
- BOOLEAN
{ "value": true }
Value has to be true or false.
- COUNTRY
{ "value": "us" }
Value has to be lowercase string in ISO 3166-1 alpha-2 format.
- CURRENCY
{
"value": {
"code": "GBP",
"value": 23232
}
}
Code of value is a currency code in ISO 4217 format.
- DATE
{ "value": "2015-11-17T23:00:00.000Z" }
- NUMBER, PERCENT
{ "value": 42 }
- REGION
{ "value": "us-wa" }
Value has to be lowercase string in ISO 3166-2 compatible format.
- SINGLE_SELECT
{ "value": "f6fe768f-b5e6-4794-9938-c2f42ab0a572" }
Value has to be an id of candidate property value (provided by GET /configuration/candidate-properties/{propertyId}/values).
- TEXT
{ "value": "Example text" }
- USER
{ "value": "50fe861de4b00265edec6775" }
Value has to be a valid user id
To reset a value for any of the above types, please pass
{}
put/candidates/{id}/properties/{propertyId}
Request
- Base URLhttps://api.smartrecruiters.com
- URLhttps://api.smartrecruiters.com/candidates/{id}/properties/{propertyId}
- Auth
- API key in header x-smarttoken
- or OAuth 2Authorization code: https://www.smartrecruiters.com/identity/oauth/allowToken URL: https://api.smartrecruiters.com/identity/oauth/token scopes: candidates_manage
Request body
Response
Property successfully updated.
Changes
No recorded changes to this operation across all 1 revision of this API.