Create a note in the scope of an existing candidate. This note can be used to add information about the candidate or to document an event on the candidate profile.

Request

POST https://api.comeet.co/candidates/{uid}/notes

Request body fields:

Name

Type

Optional

Description

time_created

string

Required

YYYY-MM-DDTHH:mm:ssZ

created_by

object

Required

created_by.type

string

Required

One of the following: user, source_contact, other, app

created_by.first_name

string

Required

created_by.middle_name

string

Optional

created_by.last_name

string

Optional

created_by.email

string

Optional

text

string

Required

HTML. The following tags are supported: <b> <i> <u> <a>

details

array of objects

Optional

details[].title

string

Required

details[].text

string

Optional

{
  "time_created": "2018-01-01T12:50:50Z",
  "created_by": {
    "first_name": "Kelly",
    "middle_name": "",
    "last_name": "Lee",
    "email": "[email protected]"
  },
  "text": "Called candidate's phone but the candidate didn't pick up.",
  "details": [
    {
      "title": "Phone number",
      "text": "+1-666-000-0000"
    }
  ]
}

Response

Returns the note object.

{
  "uid": "B12.121",
  "time_created": "2018-01-01T12:50:50Z",
  "created_by": {
    "type": "user",
    "uid": "A00.001"      
  },
  "text": "Called candidate's phone but the candidate didn't pick up.",
  "details": [
    {
      "title": "Phone number",
      "text": "+1-666-000-0000"
    }
  ]
}
{  
  "status":404,
  "error":"candidate_not_found",
  "message":"Candidate not found"
}