{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/move","auth":"required","method":"post","examples":{"codes":[{"language":"html","code":"POST /v3/company/000000000000/position/000000000000/candidate/000000000000/move HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n\t\"target_position_id\": \"000000000000\",\n\t\"target_stage_id\": \"applied\",\n  \"stage_actions_enabled\": false\n}"},{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X POST -d '{\"target_position_id\": \"000000000000\",\"target_stage_id\": \"applied\", \"stage_actions_enabled\": false }' https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/move\n\n"}]},"settings":"","results":{"codes":[{"status":200,"name":"","code":"{ Candidate Object }","language":"json"},{"language":"json","status":400,"name":"Missing Access Token","code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}"},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"moveCandidateMissingStage\",\n        \"message\": \"target_stage_id is null or empty\"\n    }\n}"},{"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\": \"postMessageError\",\n        \"message\": \"there was an unknown error posting message.\"\n    }\n}"},{"code":"{\n    \"error\": {\n        \"type\": \"moveCandidateMissingPosition\",\n        \"message\": \"target_position_id is null or empty\"\n    }\n}","language":"json","status":400},{"code":"{\n    \"error\": {\n        \"type\": \"moveCandidatePositionNotFound\",\n        \"message\": \"target position not found\"\n    }\n}","language":"json","status":404},{"code":"{\n    \"error\": {\n        \"type\": \"moveCandidateUserNotAuthorized\",\n        \"message\": \"user does not have proper access to target position\"\n    }\n}","language":"json","status":401}]},"params":[{"name":"target_position_id","type":"string","default":"","desc":"the content of the conversation to add","required":true,"in":"body","ref":"","_id":"57602da9c811102000cef2f1"},{"name":"company_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b155b1641a1700ede471"},{"name":"position_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b155b1641a1700ede470"},{"name":"candidate_id","type":"string","default":"","desc":"","required":true,"in":"path","ref":"","_id":"57a8b155b1641a1700ede46f"},{"name":"target_stage_id","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5ba28aadefb60e00031ef524"},{"name":"stage_actions_enabled","type":"boolean","default":"false","desc":"Execute stage actions on the target position / stage if they are configured","required":false,"in":"body","ref":"","_id":"5ba28aadefb60e00031ef523"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id/move","type":"endpoint","slug":"company-position-candidate-move","excerpt":"Moves a candidate from one position to another","body":"","updates":[],"order":11,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ba28a2f99699c0003e9c9bf","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-09-19T17:41:03.992Z","__v":7,"parentDoc":null,"updatedAt":"2019-07-05T13:07:01.569Z"}

post./candidate/:id/move

Moves a candidate from one position to another

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

target_position_id:
required
string
the content of the conversation to add
target_stage_id:
required
string
stage_actions_enabled:
booleanfalse
Execute stage actions on the target position / stage if they are configured

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