Skip to main content
POST
cURL
Notes are not customer messages. They stay inside Pingmee and are never sent to WhatsApp, Instagram, Messenger, email, or web chat. Do not use /sendMessage for notes — that endpoint only sends to connected messaging platforms.

Example

  • participantsIdentifiers, sender, and receiver must match an existing conversation owned by your business.
  • messageId should be a new UUID from your client.
  • createdAt is Unix time in milliseconds.

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

Body

application/json
participantsIdentifiers
string
required

Conversation key (same value returned on the conversation object)

message
string
required

Note text

type
enum<string>
required

Use note for agent notes

Available options:
note
sender
string
required

Business channel id for the conversation (conversation.phoneNumberId)

receiver
string
required

Customer id (conversation.customer.phoneNumberId or meta user id)

messageId
string
required

Client-generated UUID for the note

createdAt
number
required

Unix time in milliseconds

agentIdentification
object

Optional; defaults to the authenticated agent

Response

Note saved and broadcast to the business

Last modified on November 16, 2026