Creates a new conversation thread in the context of a specific candidate. Returns the Conversation object.
Request
POST https://api.comeet.co/candidates/{uid}/conversations
Request body fields:
| Name | Type | Optional | Description |
|---|---|---|---|
| conversation_type | string | Required | One of the following: email, chat, SMS, or InMail |
| visibility | string | Required | One of the following: All, Managers/Recruiters, or Recruiters |
| messages | Array of Message See payload fields | Required |
{
"conversation_type": "email",
"visibility": "Managers/Recruiters",
"messages": [
{
"time_sent": "2018-01-01T12:50:50Z",
"status": "Sent",
"from": {
"type": "user",
"first_name": "Kelly",
"middle_name": "",
"last_name": "Lee",
"email": "[email protected]"
},
"to": [
{
"type": "candidate",
"first_name": "John",
"middle_name": "",
"last_name": "Johnson",
"email": "[email protected]",
"status": "Sent"
}
//...
],
"cc": [],
"bcc": [],
"subject": "Director of Sales opportunity",
"body": "Hi John, I wanted to see if you would be interested in interviewing for the Director of sales role in ACME."
}
//...
]
}
Response
{
"uid": "11.11",
"conversation_type": "email",
"context_type": "candidate",
"context_uid": "A22.22",
"visibility": "Managers/Recruiters",
"messages": [
{
"uid": "B12.121",
"time_sent": "2018-01-01T12:50:50Z",
"status": "Sent",
"from": {
"type": "user",
"uid": "A00.001"
},
"to": [
{
"type": "candidate",
"uid": "B99.999"
}
//...
],
"cc": [],
"bcc": [],
"subject": "Director of Sales opportunity",
"body": "Hi John, I wanted to see if you would be interested in interviewing for the Director of sales role in ACME."
}
//...
]
}
{
"status":404,
"error":"candidate_not_found",
"message":"Candidate not found"
}