{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/company/:company_id/position/:position_id/candidate/:candidate_id/conversation","auth":"required","results":{"codes":[{"status":200,"name":"","code":"{\n  \"_id\": String,\n  \"type\": \"messageToCandidatePosted\",\n  \"object\": {\n    \"body\": String,\n    \"subject\": Subject,\n    \"attachments\": [\n      {\n        \"status\": String,\n        \"file_name\": String,\n        \"url\": String,\n        \"content_type\": String\n      },\n      ...\n    ],      \n\t\t\"candidate_id\": String,\n\t\t\"company_id\": String,\n\t\t\"position_id\": String,\n\t\t\"acting_user\": { Candidate | User}\n\t},\n\t\"timestamp\": Date\n}","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\": \"postConversationMissingBody\",\n        \"message\": \"body 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}"}]},"settings":"","examples":{"codes":[{"language":"html","code":"POST /v3/company/000000000000/position/000000000000/candidate/000000000000/conversation HTTP/1.1\nHost: api.breezy.hr\nAuthorization: 00000000-0000-0000-0000-000000000000\nContent-Type: application/json\n\n{\n  \"body\": \"Hi there! This is a test message!\"\n}"},{"language":"curl","code":"curl -H \"Content-Type: application/json\" -H \"Authorization: 00000000-0000-0000-0000-000000000000\" -X POST -d '{ \"body\": \"Hi there! This is a test message!\" }' https://api.breezy.hr/v3/company/000000000000/position/000000000000/candidate/000000000000/conversation\n\n"}]},"method":"post","params":[{"name":"body","type":"string","default":"","desc":"the content of the conversation to add","required":false,"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"}],"apiSetting":"5d1f4985a718ba002bfa4a50"},"next":{"description":"","pages":[]},"title":"./candidate/:id/conversation","type":"endpoint","slug":"company-position-candidate-conversation-add","excerpt":"Adds a new conversation message for the candidate","body":"","updates":[],"order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a60f64e792a330012d7214e","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","parentDoc":null,"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":"2016-06-14T17:11:47.158Z","githubsync":"","__v":10,"updatedAt":"2019-07-05T13:06:41.393Z"}

post./candidate/:id/conversation

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

body:
string
the content of the conversation to add

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