Set candidate properties values for the candidate's job

Below you can find a list of value examples, dependent on different candidate property types.

BOOLEAN

[{ "id": "propertyId", "value": true }]

Value has to be true or false.

COUNTRY

[{ "id": "propertyId", "value": "us" }]

Value has to be lowercase string in ISO 3166-1 alpha-2 format.

CURRENCY

[{ "id": "propertyId",
   "value": {
     "code": "GBP",
     "value": 23232
   }
 }]

Code of value is a currency code in ISO 4217 format.

DATE

[{ "id": "propertyId", "value": "2015-11-17T23:00:00.000Z" }]

NUMBER, PERCENT

[{ "id": "propertyId", "value": 42 }]

REGION

[{ "id": "propertyId", "value": "us-wa" }]

Value has to be lowercase string in ISO 3166-2 compatible format.

SINGLE_SELECT

[{ "id": "propertyId", "value": "f6fe768f-b5e6-4794-9938-c2f42ab0a572" }]

Value has to be an id of candidate property value (provided by GET /configuration/candidate-properties/{propertyId}/values).

MULTI_SELECT

[ALPHA] MULTI_SELECT is available to a limited set of customers under early access.

[{ "id": "propertyId", "value": ["f6fe768f-b5e6-4794-9938-c2f42ab0a572", "a1b2c3d4-e5f6-7890-abcd-ef1234567890"] }]

Value has to be an array of option ids (provided by GET /configuration/candidate-properties/{propertyId}/values). Duplicate ids in the array are rejected. Use an empty array or omit value to clear the field.

TEXT

[{ "id": "propertyId", "value": "Example text" }]

USER

[{ "id": "propertyId", "value": "50fe861de4b00265edec6775" }]

Value has to be a valid user id

Resetting a value

To reset a value for any of the above types, please pass:

[{"id": "propertyId"}]

For MULTI_SELECT you may also pass [{ "id": "propertyId", "value": [] }].