Adds a note to an existing lead.
This endpoint works identically to Create a Candidate Note. The request body, response schema, and behavior are the same — only the resource path differs.
Request
POST https://api.comeet.co/leads/{uid}/notesRequest path parameters:
Request body parameters:
| 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>. Due to security restrictions other tags will be removed or displayed as text. |
| details | array of objects | Optional | |
| details[].title | string | Required | |
| details[].text | string | Optional |
{
"time_created": "2024-06-05T14:30:00Z",
"created_by": {
"first_name": "John",
"middle_name": "",
"last_name": "Recruiter",
"email": "[email protected]",
"type": "user"
},
"text": "Called lead's phone but the lead didn't pick up.",
"details": [
{
"title": "Phone number",
"text": "+1-555-0100"
}
]
}Response
{
"uid": "B12.122",
"time_created": "2024-06-05T14:30:00Z",
"created_by": {
"type": "user",
"uid": "A00.002"
},
"text": "Called lead's phone but the lead didn't pick up.",
"details": [
{
"title": "Phone number",
"text": "+1-555-0100"
}
]
}{
"status":404,
"error":"candidate_not_found",
"message":"Candidate not found"
}