/candidates/:id
Update a candidate with provided ID.
Watch out when testing the endpoint here! It will update found resources!
patch/c/{company_id}/candidates/{id}
Request
- Base URLhttps://api.recruitee.com
- URLhttps://api.recruitee.com/c/{company_id}/candidates/{id}
- AuthOAuth 2
Path parameters
company_idinteger required
Company ID. A company subdomain can also be used.
idstring required
ID of a candidate
Headers
Content-Typestring
Request body
Response
200
Example response
{
"candidate": {
"phones": [
"123123123"
],
"created_at": "2021-08-18T11:42:43.810542Z",
"name": "John Smith",
"admin_id": 135145,
"emails": [
"john@example.com"
],
"social_links": [
"https://www.facebook.com/johnexamplecom/"
],
"cover_letter": "Example cover letter",
"updated_at": "2021-08-18T11:43:26.369510Z",
"photo_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/27721862/normal_photo_b3lrsc6ekdan.png",
"id": 27721862,
"viewed": true,
"cv_processing_status": "ok",
"duplicates": [
27721862
],
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/candidates/27721862/thumb_photo_b3lrsc6ekdan.png",
"last_activity_at": "2021-08-18T11:42:45.767707Z",
"source": "manual",
"links": [
"https://www.example.com/"
],
"gdpr_status": "no_consent",
"adminapp_url": "https://app.recruitee.com/#/dashboard/overview?candidate=27721862&company=49498",
"fields": [
{
"fixed": true,
"kind": "education",
"origin": "manual",
"visibility": {
"level": "public"
},
"visible": true
}
]
},
"references": [
{
"email": "marceline@example.com",
"first_name": "Marceline",
"id": 135145,
"last_name": "Example",
"photo_normal_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/admins/135145/normal_avatar_nafo2l54vchw.png",
"photo_thumb_url": "https://recruitee-main.s3.eu-central-1.amazonaws.com/admins/135145/thumb_avatar_nafo2l54vchw.png",
"time_format24": true,
"timezone": "Europe/Warsaw",
"type": "Admin"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.