{"_id":"5a99573b20047e00126fec1d","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","githubsync":"","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-02T13:52:59.929Z","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\": \"addCandidateByResumeError\",\n        \"message\": \"there was an unknown error adding candidate by resume.\"\n    }\n}"},{"code":"{\n    \"error\": {\n        \"type\": \"addCandidateByResumeDuplicate\",\n        \"message\": \"this candidate already exists on this position.\"\n    }\n}","language":"json","status":409}]},"method":"post","examples":{"codes":[{"code":"curl -X POST -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -F'data=:::at:::/path/to/file' https://app.breezy.hr/public/api/v3/company/000000000000/position/000000000000/candidates/resume?stage_id=applied&stage_actions_enabled=true\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":"5a99573b20047e00126fec20","ref":"","in":"query","required":false,"desc":"id of pipeline stage to put new candidate in","default":"applied","type":"string","name":"stage_id"},{"_id":"5a99573b20047e00126fec1f","ref":"","in":"query","required":false,"desc":"execute stage actions configured on stage candidate is being created in","default":"false","type":"boolean","name":"stage_actions_enabled"},{"_id":"5a99573b20047e00126fec1e","ref":"","in":"body","required":true,"desc":"resume file to upload","default":"","type":"file","name":"data"}],"url":"/v:version/company/:company_id/position/:position_id/candidates/resume"},"isReference":true,"order":21,"body":"","excerpt":"Upload and parse a resume file to create a new candidate","slug":"company-position-candidates-resume-add","type":"endpoint","title":"./candidates/resume"}

post./candidates/resume

Upload and parse a resume file to create a new candidate

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string

Query Params

stage_id:
stringapplied
id of pipeline stage to put new candidate in
stage_actions_enabled:
booleanfalse
execute stage actions configured on stage candidate is being created in

Body Params

data:
required
file
resume file to upload

Examples


Result Format


User Information

Try It Out

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