RErecruitwithatlas
People

Update a note

Changed on

Use this endpoint to change the text of an existing note, instead of adding a new note every time.

What you need to provide:

  • The note's ID in the URL path - returned as id by Create a note on a person and by the note list endpoints
  • note (required) - the new text. It replaces the existing text. HTML tags are stripped, the same as when a note is created. An empty string, or text that is only HTML tags, is rejected with a 422.

Only the text can be changed. The note keeps its person, project, type and author, and sending any other field is rejected with a 422.

What you get back: the updated note, in the same shape as a row of List notes across the agency (without deletedAt). Its updatedAt moves forward when the text changed, so the edit flows through an updatedAfter sync cursor.

Returns 404 when:

  • No note with this ID exists in your agency, or it has been deleted.
patch/api/v1/people/notes/{noteId}

Request

Path parameters

noteIdstring uuid required

Note ID

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

Request body

notestring required

The new note text. Replaces the existing text. HTML tags are stripped.

Example request

{
  "note": "Spoke again — now open to hybrid roles."
}

Response

Note updated

status'ok' required

Example response

{
  "data": {
    "text": "BD call - happy for us to send two profiles this week.",
    "type": "phone_call",
    "createdBy": {
      "name": "Sarah Johnson",
      "email": "sarah@agency.com"
    }
  }
}

Changes