v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB

chat

get customer note

Retrieves the note associated with a customer chat.

post/instances/{id}/client/action/get-customer-note

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

Chat ID <countrycode_short><usernumber>@c.us or @g.us for groups

Example request

{
  "chatId": "50664083362@c.us"
}

Response

Customer note retrieved successfully

status'success' | 'error'

instanceIdstring

Example response

{
  "status": "success",
  "instanceId": "1",
  "data": {
    "note": {
      "chatId": "1234567890@c.us",
      "content": "VIP customer, handle with care",
      "createdAt": "2026-04-02T10:00:00Z",
      "id": "note_abc123",
      "modifiedAt": "2026-04-02T10:00:00Z",
      "type": "customer_note"
    }
  }
}