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

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