{"_id":"5b7db1d323ad950003c4ae2c","project":"54ee19c23749bf0d00c76515","version":{"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":2,"createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5a60f64d792a330012d72146","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T20:55:14.360Z","from_sync":false,"order":6,"slug":"candidate-endpoints","title":"Candidate Endpoints"},"user":"575f003663430e0e008a8704","__v":4,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-08-22T18:56:19.048Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"code":"{\n   Candidate Object\n}","language":"json","status":200,"name":""},{"name":"Missing Access Token","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","language":"json","status":400},{"status":401,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}"},{"status":500,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"updateCandidateError\",\n        \"message\": \"there was an unknown error updating candidate.\"\n    }\n}"}]},"method":"put","examples":{"codes":[{"code":"PUT /public/api/v3/company/000000000000/position/000000000000/candidate/000000000000 HTTP/1.1\nHost: breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"name\": \"New Candidate\",\n  \"email_address\": \"candidate:::at:::emailaddress.com\",\n  \"phone_number\": \"123-456-7890\",\n  \"summary\": \"I will be a good candidate for any job you have!\",\n  \"tags\": [\"technical\", \"junior\"],\n  \"source\": \"LinkedIn\",\n  \"headline\": \"This is the candidate headline\",\n  \"address\": \"1234 Mockingbird Lane\\nTopeka, KS 12345\",\n  \"social_profiles\": {\n  \t\"facebook\": \"https://link.to/facebook\",\n    \"github\": \"https://link.to/github\"\n  }\n}","name":"","gist":"d8b94c22c836cf372959","language":"http"},{"code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X PUT -d '{ \"name\": \"New Candidate\", \"email_address\": \"candidate@emailaddress.com\", \"phone_number\": \"123-456-7890\", \"summary\": \"I will be a good candidate for any job you have!\", \"tags\": [\"technical\", \"junior\"], \"source\": \"LinkedIn\", \"headline\": \"This is the candidate headline\", \"address\": \"1234 Mockingbird Lane\\nTopeka, KS 12345\", \"social_profiles\": { \"facebook\": \"https://link.to/facebook\", \"github\": \"https://link.to/github\" }}' https://breezy.hr/public/api/v3/company/000000000000/position/000000000000/candidate/000000000000\n\n","language":"curl"}]},"auth":"required","params":[{"_id":"57a8b2f81ec0f519003e6130","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"company_id"},{"_id":"57a8b2f81ec0f519003e612f","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"position_id"},{"_id":"5b7db1d323ad950003c4ae30","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"candidate_id"},{"_id":"5a695170a1ca6c0012da595a","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"name"},{"_id":"5a695170a1ca6c0012da5959","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"email_address"},{"_id":"5a695170a1ca6c0012da5958","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"phone_number"},{"_id":"5a695170a1ca6c0012da5957","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"summary"},{"_id":"5a737863ae5cef00124951d5","ref":"","in":"body","required":false,"desc":"custom source to attribute to the incoming candidate","default":"Breezy API","type":"string","name":"source"},{"_id":"5a695170a1ca6c0012da5956","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_string","name":"tags"},{"_id":"5b7db1d323ad950003c4ae2f","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"headline"},{"_id":"5b7db1d323ad950003c4ae2e","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"address"},{"_id":"5b7db1d323ad950003c4ae2d","ref":"","in":"body","required":false,"desc":"valid properties ( facebook | linkedin | twitter | dribbble | instagram | behance | angellist | flickr | github | youtube | google-plus | skype | globe )","default":"","type":"object","name":"social_profiles"}],"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id"},"isReference":true,"order":1,"body":"","excerpt":"Updates a candidate on a position","slug":"company-position-candidate-update","type":"endpoint","title":"./candidate/:id"}

put./candidate/:id

Updates a candidate on a position

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string
candidate_id:
required
string

Body Params

name:
string
email_address:
string
phone_number:
string
summary:
string
source:
stringBreezy API
custom source to attribute to the incoming candidate
tags:
array of strings
headline:
string
address:
string
social_profiles:
object
valid properties ( facebook | linkedin | twitter | dribbble | instagram | behance | angellist | flickr | github | youtube | google-plus | skype | globe )

Examples


Result Format


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}