{"_id":"5ba28a2f99699c0003e9c9bf","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"},"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":"575f003663430e0e008a8704","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-09-19T17:41:03.992Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"POST /public/api/v3/company/000000000000/position/000000000000/candidate/000000000000/move HTTP/1.1\nHost: 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":"html"},{"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://breezy.hr/public/api/v3/company/000000000000/position/000000000000/candidate/000000000000/move\n\n","language":"curl"}]},"settings":"","results":{"codes":[{"language":"json","code":"{ Candidate Object }","name":"","status":200},{"code":"{\n    \"error\": {\n        \"type\": \"missingAccessToken\",\n        \"message\": \"access token is null or empty\"\n    }\n}","name":"Missing Access Token","status":400,"language":"json"},{"code":"{\n    \"error\": {\n        \"type\": \"moveCandidateMissingStage\",\n        \"message\": \"target_stage_id 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\": \"postMessageError\",\n        \"message\": \"there was an unknown error posting message.\"\n    }\n}","language":"json","status":500},{"status":400,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"moveCandidateMissingPosition\",\n        \"message\": \"target_position_id is null or empty\"\n    }\n}"},{"status":404,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"moveCandidatePositionNotFound\",\n        \"message\": \"target position not found\"\n    }\n}"},{"status":401,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"moveCandidateUserNotAuthorized\",\n        \"message\": \"user does not have proper access to target position\"\n    }\n}"}]},"auth":"required","params":[{"_id":"57602da9c811102000cef2f1","ref":"","in":"body","required":true,"desc":"the content of the conversation to add","default":"","type":"string","name":"target_position_id"},{"_id":"57a8b155b1641a1700ede471","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"company_id"},{"_id":"57a8b155b1641a1700ede470","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"position_id"},{"_id":"57a8b155b1641a1700ede46f","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"candidate_id"},{"_id":"5ba28aadefb60e00031ef524","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"target_stage_id"},{"_id":"5ba28aadefb60e00031ef523","ref":"","in":"body","required":false,"desc":"Execute stage actions on the target position / stage if they are configured","default":"false","type":"boolean","name":"stage_actions_enabled"}],"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/move"},"isReference":true,"order":8,"body":"","excerpt":"Adds a new conversation message for the candidate","slug":"company-position-candidate-move","type":"endpoint","title":"./candidate/:id/move"}

post./candidate/:id/move

Adds a new conversation message for the candidate

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