{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/send-questionnaire","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/send-questionnaire?questionnaire_id=000000000000"}]},"settings":"","results":{"codes":[{"name":"","code":"{ \n  CandidateQuestionnaire Object\n}","language":"json","status":200},{"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\": \"getQuestionnairesError\",\n        \"message\": \"there was an unknown error getting candidate questionnaires.\"\n    }\n}"},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"sendQuestionnaireMissingId\",\n        \"message\": \"questionnaire_id is null or empty\"\n    }\n}"}]},"method":"post","params":[{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b1e0cdeea20e001d2a3f"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b1e0cdeea20e001d2a3e"},{"name":"candidate_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b1e0cdeea20e001d2a3d"},{"name":"questionnaire_id","type":"string","default":"","desc":"","required":true,"in":"query","ref":"","_id":"5a746cafabc4570012571d4d"},{"name":"email_candidate","type":"boolean","default":"false","desc":"should the result of this action send an email to the candidate to complete questionnaire","required":false,"in":"query","ref":"","_id":"5a746cafabc4570012571d4c"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id/send-questionnaire","type":"endpoint","slug":"company-position-candidate-send-questionnaire","excerpt":"Create a new questionnaire for a candidate","body":"","updates":[],"order":16,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a746cafabc4570012571d4b","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-02-02T13:50:39.449Z","githubsync":"","__v":4,"parentDoc":null,"updatedAt":"2019-07-05T13:07:15.731Z"}

post./candidate/:id/send-questionnaire

Create a new questionnaire for a candidate

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Query Params

questionnaire_id:
required
string
email_candidate:
booleanfalse
should the result of this action send an email to the candidate to complete questionnaire

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