Update Note

Update Note

POST

Update a note by id.

Request

POST /v1/note/{id}

Path Parameters

Parameter	Type	Required	Description
id	integer	Yes	Note id.

Body Parameters

Parameter	Type	Required	Description
note	string	Yes	Updated note text.
related_to	string	No	Candidate, contact, organization, job, or deal slug.
related_to_type	integer	No	Entity type. Allowed values: 1 candidate, 2 job, 3 organization, 4 contact, 5 deal.
note_type_id	integer	No	Note type id.
updated_by	integer	No	User id to use as the updater.

Request Example

{
  "note": "Candidate confirmed availability for Tuesday.",
  "related_to": "candidate_0d25558c1a77fc2d7d98",
  "related_to_type": 1,
  "note_type_id": 2
}

Response

200

{
  "id": 84,
  "note_type": {
    "id": 2,
    "label": "General"
  },
  "note": "Candidate confirmed availability for Tuesday.",
  "related_to": "candidate_0d25558c1a77fc2d7d98",
  "related_record": {
    "slug": "candidate_0d25558c1a77fc2d7d98"
  },
  "related_to_type": 1,
  "created_by": {
    "id": 1
  },
  "updated_by": {
    "id": 1
  },
  "created_at": "2026-07-24T10:15:00.000Z",
  "updated_at": "2026-07-24T10:30:00.000Z"
}

404

{
  "message": "Note not found"
}