API referenceConversations

Add an internal note

POST
/v2/conversations/{id}/notes

Visible to the team only, never to the customer.

Authorization

ApiKey
headerAuthorizationBearer <token>

An API key from Developers → API keys: Authorization: Bearer gauge_live_… (or pulse_k_live_…).

Path Parameters

id*string

The conversation id.

Formatuuid

Header Parameters

Gauge-Version?string

A dated version. Default 2026-10-21.

Idempotency-Key*string

Required on every POST. Retries with the same key replay the first response for 24 h.

Length1 <= length <= 255

Request Body

application/json
  1. body
body*string
Length1 <= length <= 8192
messageId?string
Formatuuid

Response Body

The note.

application/json
  1. response
id*string
Formatuuid
conversationId*string
Formatuuid
authorMemberId*|
Formatuuid
messageId*|
Formatuuid
body*string
createdAt*string
Example Request
curl -X POST 'https://app.gauge.chat/api/v2/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/notes' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "body": "string"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",  "authorMemberId": "76fc4ed4-930e-473e-a8fc-09f425f86e65",  "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",  "body": "string",  "createdAt": "string"}