notes

Update a note

Updates the content or visibility of an existing note. Only the fields you provide will be changed — any field you omit will remain unchanged. Use the note ID returned when the note was created.

patch/v1/notes/{noteId}

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/notes/:noteId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

noteIdstring required

Public note ID returned by Create Note or Fetch Notes.

Request body

contentstring

The updated content of the note. Supports plain text.

visibility'1' | '2'

Updated visibility setting. Use "1" for public (visible to all team members) or "2" for private (visible only to you).

status'0' | '1'

Updated status of the note. Use "0" for draft or "1" for published.

Example request

{
  "content": "Prospect confirmed interest. Schedule a demo call for next Monday.",
  "visibility": "2",
  "status": "1"
}

Response

Note updated successfully

unknown required

Example response

{
  "message": "Note updated successfully",
  "payload": {
    "id": "Nt7Yp4Za",
    "prospectId": "Pr9xQ2Lm",
    "visibility": "1",
    "status": "1",
    "content": "<p>Updated renewal timeline.</p>",
    "createdAt": "2026-04-21T10:57:07.000Z",
    "updatedAt": "2026-04-21T10:58:28.000Z",
    "editedAt": "2026-04-21T10:58:29.000Z",
    "editedBy": {
      "firstName": "Avery",
      "lastName": "Stone",
      "email": "avery.stone@example.org"
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.