Notes

Every resource except links keeps a running list of notes on the record. Append one with a single call; Leasync stamps it with your user id and the current time and logs it on the activity timeline.

Endpoints#

Add a note#

POST/{resource}/{id}/notes

Appends a note to a client, space, deal, broker, landlord, or commission. Returns the new note with status 201. Requires the write scope. Links answer 405 notes_not_supported.

Parameters

Parameters for POST /{resource}/{id}/notes
Name	Type	Description
`resource`required	string	clients, spaces, deals, brokers, landlords, or commissions.
`id`required	uuid	The record id.
`text`required	string	Body field. Up to 20,000 characters; whitespace is trimmed.

Request

bash

curl -X POST https://www.leasync.ai/api/v1/deals/6f1c8d20-5e3b-4a9f-b2c7-0d8e4a6b1c33/notes \
  -H "Authorization: Bearer lsk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "text": "LL wants 3 months security instead of 2." }'

Response

json

{
  "data": {
    "id": "c3d4e5f6-…",
    "text": "LL wants 3 months security instead of 2.",
    "createdBy": "a1c2d3e4-…",
    "createdAt": "2026-09-24T15:12:08.000Z"
  }
}

Notes in create and update bodies#

You can also set notes directly on create or update as an array of { "text": "…" } objects; Leasync fills in the author and timestamp. On update this replaces the whole list, so prefer the endpoint above to add one.

If you can see a record but cannot edit it, adding a note returns 403 forbidden.