{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/stage","auth":"required","method":"put","results":{"codes":[{"name":"","status":204,"language":"json","code":""},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token"},{"status":401,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"invalidAccessToken\",\n        \"message\": \"access token is invalid\"\n    }\n}"},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"setCandidateStatusMissingStageId\",\n        \"message\": \"stage_id is null or empty\"\n    }\n}"},{"status":500,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"setCandidateStatusError\",\n        \"message\": \"there was an unknown error setting candidate stage.\"\n    }\n}"}]},"settings":"","examples":{"codes":[{"language":"http","code":"PUT /v3/company/000000000000/position/000000000000/candidate/000000000000/stage HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"stage_id\": \"000000000000\"  \n}"},{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X PUT -d '{ \"stage_id\": \"000000000000\" }' https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/stage"}]},"params":[{"name":"stage_id","type":"string","default":"","desc":"The ID of the Pipeline stage to put the candidate in (hired, disqualified, offer, feedback, interviewing, applied)","required":false,"in":"body","ref":"","_id":"54fce3877cb4000d0031731e"},{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b23e3ec56d0e001ee3e0"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b23e3ec56d0e001ee3df"},{"name":"candidate_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b23e3ec56d0e001ee3de"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id/stage","type":"endpoint","slug":"company-position-candidate-stage-update","excerpt":"Move candidate to specified stage","body":"","updates":[],"order":17,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a60f64e792a330012d72157","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},"parentDoc":null,"user":"575f003663430e0e008a8704","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},"createdAt":"2015-03-09T00:03:01.952Z","githubsync":"","__v":7,"updatedAt":"2019-07-05T13:07:18.258Z"}

put./candidate/:id/stage

Move candidate to specified stage

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

stage_id:
string
The ID of the Pipeline stage to put the candidate in (hired, disqualified, offer, feedback, interviewing, applied)

Examples


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