{"_id":"5a60f64e792a330012d7215d","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":"54ee197f67e09c230091e707","parentDoc":null,"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"},"githubsync":"","__v":12,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-12T15:35:49.738Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"POST /public/api/v3/company/000000000000/position/000000000000/candidates 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  \"origin\": \"applied\",\n  \"address\": \"1234 Mockingbird Lane\\nTopeka KS, 12345\",\n  \"work_history\": [\n  \t{\n    \t\"company_name\": \"Widget Corp\",\n      \"title\": \"Widget Maker\",\n      \"summary\": \"I made all the widgets\",\n      \"start_month\": 1,\n      \"start_year\": 2015,\n      \"end_month\": 10,\n      \"end_year\": 2017\n    }\n  ],\n  \"education\": [\n  \t{\n    \t\"school_name\": \"Widget School\",\n      \"field_of_study\": \"Widget Making\",\n      \"start_year\": 2017,\n      \"end_year\": 11\n    }\n  ],\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 POST -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\",\"origin\": \"applied\", \"address\": \"1234 Mockingbird Lane\\nTopeka KS, 12345\", \"work_history\": [{\"company_name\": \"Widget Corp\",\"title\": \"Widget Maker\",\"summary\": \"I made all the widgets\",\"start_month\": 1,\"start_year\": 2015,\"end_month\": 10,\"end_year\": 2017}],\"education\": [{\"school_name\": \"Widget School\",\"field_of_study\": \"Widget Making\",\"start_year\": 2017,\"end_year\": 11}], \"social_profiles\": { \"facebook\": \"https://link.to/facebook\", \"github\": \"https://link.to/github\"} }' https://breezy.hr/public/api/v3/company/000000000000/position/000000000000/candidates\n\n","language":"curl"}]},"method":"post","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},{"code":"{\n    \"error\": {\n        \"type\": \"addCandidateMissingName\",\n        \"message\": \"name is null or empty\"\n    }\n}","language":"json","name":"Missing Name","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\": \"addCandidateError\",\n        \"message\": \"there was an unknown error creating candidate.\"\n    }\n}"}]},"settings":"","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":"5a695170a1ca6c0012da595a","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"name"},{"_id":"5a695170a1ca6c0012da5959","ref":"","in":"body","required":false,"desc":"*required when origin is \"applied\"","default":"","type":"string","name":"email_address"},{"_id":"5a695170a1ca6c0012da5958","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"phone_number"},{"_id":"5b7db3a69c5d630003db9a81","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"address"},{"_id":"5a695170a1ca6c0012da5957","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"summary"},{"_id":"5a695170a1ca6c0012da5956","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_string","name":"tags"},{"_id":"5a737863ae5cef00124951d6","ref":"","in":"body","required":false,"desc":"( sourced | applied ) -> will indicate in Breezy if the candidate should be marked as sourced or applied","default":"sourced","type":"string","name":"origin"},{"_id":"5a737863ae5cef00124951d5","ref":"","in":"body","required":false,"desc":"custom source to attribute to the incoming candidate","default":"Breezy API","type":"string","name":"source"},{"_id":"5a737863ae5cef00124951d4","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_object","name":"work_history"},{"_id":"5a737863ae5cef00124951d3","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_object","name":"education"},{"_id":"5b7db3a69c5d630003db9a80","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/candidates"},"isReference":true,"order":18,"body":"","excerpt":"Add a new candidate to a position","slug":"company-position-candidates-add","type":"endpoint","title":"./candidates"}

post./candidates

Add a new candidate to a position

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

company_id:
required
string
position_id:
required
string

Body Params

name:
required
string
email_address:
string
*required when origin is "applied"
phone_number:
string
address:
string
summary:
string
tags:
array of strings
origin:
stringsourced
( sourced | applied ) -> will indicate in Breezy if the candidate should be marked as sourced or applied
source:
stringBreezy API
custom source to attribute to the incoming candidate
work_history:
array of objects
education:
array of objects
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

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