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

# Add an internal note

> Adds an internal note to a contact. Internal notes are private to your workspace — they appear inline in the conversation thread and on the contact panel, and are never visible to the customer. Identify the contact by **either** `conversationId` **or** `phone` (exactly one). The note's author is shown as **API**.

Rate limit: 30 requests per minute.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/notes
openapi: 3.1.0
info:
  title: Adraa Inbox API
  description: >-
    Public REST API for Adraa Inbox. Assign agents to conversations and send
    messages from your own systems. Authenticate every request with a workspace
    API token.
  version: 1.0.0
  contact:
    email: support@adraa.ai
servers:
  - url: https://api.inbox.adraa.ai
    description: Production
security:
  - apiToken: []
paths:
  /api/v1/notes:
    post:
      summary: Add an internal note
      description: >-
        Adds an internal note to a contact. Internal notes are private to your
        workspace — they appear inline in the conversation thread and on the
        contact panel, and are never visible to the customer. Identify the
        contact by **either** `conversationId` **or** `phone` (exactly one). The
        note's author is shown as **API**.


        Rate limit: 30 requests per minute.
      operationId: addNote
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - body
              properties:
                conversationId:
                  type: string
                  description: >-
                    ID of a conversation whose contact the note is attached to.
                    Provide this **or** `phone`, not both. List conversations
                    with `GET /api/v1/conversations`.
                  example: cmbxgz9pq0003ph01m4n5o6p7
                phone:
                  type: string
                  minLength: 3
                  maxLength: 32
                  description: >-
                    WhatsApp phone number of the contact, in international
                    format. Provide this **or** `conversationId`, not both.
                    Resolves to the contact's most recently active WhatsApp
                    conversation.
                  example: '+971500000000'
                body:
                  type: string
                  maxLength: 4000
                  description: Note text. Maximum 4000 characters.
                  example: VIP customer — fast-track any shipping issues.
      responses:
        '201':
          description: Note added
          content:
            application/json:
              schema:
                type: object
                properties:
                  note:
                    $ref: '#/components/schemas/ContactNote'
        '400':
          description: Missing body, or not exactly one of conversationId/phone
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: VALIDATION_ERROR
                  message: Provide exactly one of conversationId or phone
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: >-
            The conversation or the phone number's contact was not found in this
            workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: CONTACT_NOT_FOUND
                  message: Contact not found
components:
  schemas:
    ContactNote:
      type: object
      properties:
        id:
          type: string
          example: cmbxh3m2b0004ph01y6z7a8b9
        body:
          type: string
          example: VIP customer — fast-track any shipping issues.
        createdAt:
          type: string
          format: date-time
          example: '2026-06-10T14:02:00.000Z'
        agent:
          type: object
          nullable: true
          description: >-
            The agent who wrote the note, or `null` when the note was added
            through the API (author shown as "API").
          properties:
            id:
              type: string
              example: cmbxgwq1e0000ph01i0j1k2l3
            nickname:
              type: string
              example: sara
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable explanation.
            details:
              description: Field-level details for validation errors.
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_API_TOKEN
              message: Invalid or revoked API token
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: >-
        Workspace API token created in Settings → API. Tokens start with
        `adraa_`.

````