Add Note

Adds a note to a chat. Notes are internal — the visitor never sees them.

Useful for leaving context before handing a chat to a person: what was asked, what was tried, why it is being passed on.

Request

PUT /v2/chats/5a0da3c3-4882-3352-8db9-8fc47e14111f/notes/b5f0f293-086a-4290-b3e1-68069629eebf HTTP/1.1
Authorization: Bearer oauth_token
Content-Type: application/json

{
  "body": "Visitor asked about billing. Out of scope for this integration."
}

Path Parameters

/v2/chats/{chatId}/notes/{noteId}

Request Body

Unlike a message, a note does not require the chat to be assigned to the caller.

{noteId} is a caller-generated UUID and behaves like a message id: reusing one returns 422 id value is already in use instead of duplicating the note.

A note is not an answer. If the visitor is waiting on a reply, a note does not change that — see End Chat.

Response

Every write answers with the chat, in the same shape Get Chat returns — so a caller sees the result of what it just did without a follow-up read.

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
  "id": "5a0da3c3-4882-3352-8db9-8fc47e14111f",
  "beaconId": "ed8e9fe0-acf4-4b44-b1fc-a5bff956e7a8",
  "mailboxId": 2599,
  "createdAt": "2020-07-03T07:03:29.982028Z",
  "assignee": { "id": 4440, "type": "agent", "first": "Jack", "last": "Sprout" },
  "customer": { "id": 498746, "type": "customer", "first": "Vernon", "last": "Bear" },
  "_embedded": {
    "events": [ "..." ]
  },
  "_links": {
    "self": { "href": "..." }
  }
}

The full field reference is on Get Chat.

Errors