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

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