Notes

Edit a note

Change a note's text.

PATCH/sites/{siteId}/notes/{noteId}

Edit a note

curl --request PATCH \
  --url 'https://truestat.io/api/v1/sites/{siteId}/notes/{noteId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "body": "<string>"
}'

{
  "data": {
    "id": "02eae3c2-3790-4edd-a2ff-577eb2a8b0ba",
    "body": "Deployed v2 — rolled back at 14:20",
    "author_id": "734c7de3-58f1-46e6-83d1-2be85466ee70",
    "updated_at": "2026-09-16T14:31:02.000Z",
    "granularity": "minute",
    "occurred_at": "2026-09-16T10:00:00+00:00"
  },
  "meta": {
    "site_id": "6fed8980-a119-4a9c-a4d4-53e448ef9f9e"
  }
}

See Notes for how authorship works and when to use date versus minute.

Authorizations

Authorizationstringheaderrequired

An API key from Settings → API keys. Scopes available: analytics:read, sites:read, sites:write, settings:read, settings:write, goals:read, goals:write, funnels:read, funnels:write, notes:read, notes:write, alerts:read, alerts:write, team:read, team:write, revenue:read, revenue:write.

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

siteIdstring (uuid)pathrequired

The site's id, from `GET /sites`. A site that is not yours and a site that does not exist both answer 403, so this cannot be used to discover other people's ids.

noteIdstring (uuid)pathrequired

The note's id, from the list endpoint or the create response.

Request bodyapplication/json

bodystringbodyrequired

The replacement text.

Response

application/json

The answer.

dataobject

metaobject

errorobject