curl --request POST \
--url https://{projectID}.texterchat.com/server/api/v2/chats/{chatId}/chat-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "Customer asked for a refund on order 1234"
}
'{
"_id": "6731f0c2a1b2c3d4e5f60718",
"chatId": "67a87067aeed4dee1271cb4d",
"text": "Customer asked for a refund on order 1234",
"messageId": "6731efa0a1b2c3d4e5f60701",
"author": {
"actor": {
"type": "jwt",
"issuer": "https://texterchat.com/demo",
"kid": "a1b2c3"
},
"customName": "Refunds system"
},
"createdAt": 1762851000000,
"updatedAt": 1762851000000
}Chat Notes
Create Chat Note
Add an internal note to a chat. Agents see notes in the inbox next to the conversation; the contact never sees them.
POST
https://{projectID}.texterchat.com/server/api/v2
/
chats
/
{chatId}
/
chat-notes
curl --request POST \
--url https://{projectID}.texterchat.com/server/api/v2/chats/{chatId}/chat-notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "Customer asked for a refund on order 1234"
}
'{
"_id": "6731f0c2a1b2c3d4e5f60718",
"chatId": "67a87067aeed4dee1271cb4d",
"text": "Customer asked for a refund on order 1234",
"messageId": "6731efa0a1b2c3d4e5f60701",
"author": {
"actor": {
"type": "jwt",
"issuer": "https://texterchat.com/demo",
"kid": "a1b2c3"
},
"customName": "Refunds system"
},
"createdAt": 1762851000000,
"updatedAt": 1762851000000
}Required token scopes:
Add notes to all chats
The note is attached to a message of the chat: the one you send in messageId, or else the chat’s latest message. A chat with no messages gets a note without messageId.
The note’s author is your API token. Send customName to show your own name in the inbox (for example your system’s name); otherwise the inbox shows a default name for API notes.הרשאות
API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.
פרמטרי נתיב
The unique identifier of the chat. You can obtain this value by using the Search Chats endpoint with the contact's phone number
גוף
application/json
The note text, up to 4096 characters
Maximum string length:
4096ID of a message in this chat to attach the note to. Defaults to the chat's latest message. A message of another chat returns 400
Author name shown in the inbox instead of the default. Up to 50 characters, must contain a visible character
Maximum string length:
50תגובה
The created note
An internal note on a chat
Unique note ID
דוגמה:
"6731f0c2a1b2c3d4e5f60718"
ID of the chat the note belongs to
דוגמה:
"67a87067aeed4dee1271cb4d"
The note text
Who wrote the note. Kept as it is on every edit
Show child attributes
Show child attributes
Creation time, Unix milliseconds
דוגמה:
1762851000000
Last change time, Unix milliseconds
דוגמה:
1762851000000
ID of the chat message the note is attached to. Missing when the chat had no messages
Who made the last text edit. Missing on notes that were never edited
Show child attributes
Show child attributes