{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id","auth":"required","settings":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n   Candidate Object\n}"},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token"},{"code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}","language":"json","status":401},{"code":"{\n    \"error\": {\n        \"type\": \"updateCandidateError\",\n        \"message\": \"there was an unknown error updating candidate.\"\n    }\n}","language":"json","status":500}]},"method":"put","examples":{"codes":[{"language":"http","gist":"d8b94c22c836cf372959","name":"","code":"PUT /v3/company/000000000000/position/000000000000/candidate/000000000000 HTTP/1.1\nHost: api.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  \"cover_letter\": \"Please consider me\"\n}"},{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X PUT -d '{ \"name\": \"New Candidate\", \"email_address\": \"[email protected]\", \"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\" }, \"cover_letter\": \"Please consider me\"}' https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000\n\n"}]},"params":[{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b2f81ec0f519003e6130"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b2f81ec0f519003e612f"},{"name":"candidate_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"5b7db1d323ad950003c4ae30"},{"name":"name","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a695170a1ca6c0012da595a"},{"name":"email_address","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a695170a1ca6c0012da5959"},{"name":"phone_number","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a695170a1ca6c0012da5958"},{"name":"summary","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a695170a1ca6c0012da5957"},{"name":"source","type":"string","default":"Breezy API","desc":"custom source to attribute to the incoming candidate","required":false,"in":"body","ref":"","_id":"5a737863ae5cef00124951d5"},{"name":"tags","type":"array_string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a695170a1ca6c0012da5956"},{"name":"headline","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b7db1d323ad950003c4ae2f"},{"name":"address","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b7db1d323ad950003c4ae2e"},{"name":"social_profiles","type":"object","default":"","desc":"valid properties ( facebook | linkedin | twitter | dribbble | instagram | behance | angellist | flickr | github | youtube | google-plus | skype | globe )","required":false,"in":"body","ref":"","_id":"5b7db1d323ad950003c4ae2d"},{"name":"cover_letter","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cd5cc7177fd890039c1e79a"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id","type":"endpoint","slug":"company-position-candidate-update","excerpt":"Updates a candidate on a position","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b7db1d323ad950003c4ae2c","project":"54ee19c23749bf0d00c76515","version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568","5d1f4985a718ba002bfa4a52","5d1f53e3d10632001825a1f3"],"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","__v":4},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Candidate Endpoints","slug":"candidate-endpoints","order":6,"from_sync":false,"reference":true,"_id":"5a60f64d792a330012d72146","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","createdAt":"2015-02-25T20:55:14.360Z","__v":0},"user":"575f003663430e0e008a8704","createdAt":"2018-08-22T18:56:19.048Z","__v":8,"parentDoc":null,"updatedAt":"2019-07-05T13:06:23.828Z"}

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 )
cover_letter:
string

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 }}