> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pingmee.co.il/llms.txt
> Use this file to discover all available pages before exploring further.

# Add Note

> Add an internal note (or other informative message) to a conversation. Notes are Pingmee-only: they are not delivered to WhatsApp, Instagram, Messenger, email, or web chat. Use this endpoint for notes — do not send them through `/sendMessage`.

> [!NOTE]
>
> **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`](https://docs.pingmee.co.il/api-reference/messages/send-message) for notes — that endpoint only sends to connected messaging platforms.

### Example

```json theme={null}
{
  "participantsIdentifiers": "1234567890#972501234567",
  "message": "Customer asked to be called back tomorrow morning.",
  "type": "note",
  "sender": "1234567890",
  "receiver": "972501234567",
  "messageId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": 1731355200000
}
```

* `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.


## OpenAPI

````yaml POST /addInformativeMessage
openapi: 3.1.0
info:
  title: Pingmee API
  description: A complete guide to Pingmee micro service architecture.
  version: 1.0.0
servers:
  - url: https://api.pingmee.co.il
security:
  - cookieAuth: []
    ApiKeyAuth: []
paths:
  /addInformativeMessage:
    post:
      description: >-
        Add an internal note (or other informative message) to a conversation.
        Notes are Pingmee-only: they are not delivered to WhatsApp, Instagram,
        Messenger, email, or web chat. Use this endpoint for notes — do not send
        them through `/sendMessage`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - participantsIdentifiers
                - message
                - type
                - sender
                - receiver
                - messageId
                - createdAt
              properties:
                participantsIdentifiers:
                  type: string
                  description: >-
                    Conversation key (same value returned on the conversation
                    object)
                message:
                  type: string
                  description: Note text
                type:
                  type: string
                  enum:
                    - note
                  description: Use `note` for agent notes
                sender:
                  type: string
                  description: >-
                    Business channel id for the conversation
                    (`conversation.phoneNumberId`)
                receiver:
                  type: string
                  description: >-
                    Customer id (`conversation.customer.phoneNumberId` or meta
                    user id)
                messageId:
                  type: string
                  description: Client-generated UUID for the note
                createdAt:
                  type: number
                  description: Unix time in milliseconds
                agentIdentification:
                  type: object
                  description: Optional; defaults to the authenticated agent
                  properties:
                    name:
                      type: string
                    email:
                      type: string
                  additionalProperties: false
              additionalProperties: false
      responses:
        '200':
          description: Note saved and broadcast to the business
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Conversation not found for this business
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: header
      name: Cookie
      description: Personal access token from Pingmee Settings → Developer Tools
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Business API key from Pingmee Settings → Developer Tools

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.