The Chat Note object - Texterchat

Notes are internal: agents see them in the inbox next to the conversation, and the contact never sees them. Agents, bots, scenarios and API tokens can all write notes, and every note records who wrote it and who edited it last.

Returned by: List Chat Notes · Get Chat Note · Create Chat Note · Update Chat Note

Example chat note object

{
  "_id": "6731f0c2a1b2c3d4e5f60718",
  "chatId": "67a87067aeed4dee1271cb4d",
  "text": "Refund approved, order 1234",
  "messageId": "6731efa0a1b2c3d4e5f60701",
  "author": {
    "actor": { "type": "system", "component": "bot" },
    "customName": "Order bot"
  },
  "lastEditor": {
    "actor": { "type": "jwt", "issuer": "https://texterchat.com/demo", "kid": "a1b2c3" },
    "customName": "Refunds system"
  },
  "createdAt": 1762851000000,
  "updatedAt": 1762851300000
}

Fields

Field	Type	Description
`_id`	`string`	Unique note ID
`chatId`	`string`	ID of the chat the note belongs to
`text`	`string`	The note text, up to 4096 characters
`messageId`	`string`	ID of the chat message the note is attached to. Missing when the chat had no messages when the note was created
`author`	`object`	Who wrote the note (see Attribution). Kept as it is on every edit
`lastEditor`	`object`	Who made the last text edit, same shape as `author`. Missing on notes that were never edited
`createdAt`	`integer`	Creation time, Unix milliseconds
`updatedAt`	`integer`	Last change time, Unix milliseconds

Attribution

Field	Type	Description
`actor`	`object`	Who did it. The fields depend on `actor.type`, see below
`customName`	`string`	Name shown in the inbox instead of the default name for the actor, up to 50 characters. Missing when none was set

`actor.type`	Meaning	Other actor fields
`user`	An agent in the inbox	`uid`, and optionally `email` and `name`
`system`	A bot or a scenario	`component`: `bot` or `scenario`
`jwt`	An API token	`issuer`, and optionally `kid`
`legacyToken`	An older API token	`tokenSha256`
`unknown`	Not known	none

The authorSources[] filter of List Chat Notes groups these types: user, bot, scenario, api (jwt and legacyToken) and unknown.