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

# Add an internal comment to a thread

> Adds an internal (team-only) comment to the thread, as the acting user,
the same as commenting in the app. It is never sent to the contact.
`content` is HTML and is sanitized. Mention markup in it labels the
thread for the mentioned users and teams, marks it unread for them and
notifies them. Mentioned contacts and location cards are related to the
thread.

The acting user is the delegate token's own user. With an API key or
partner token, name one in `userId`. Guests cannot comment.




## OpenAPI

````yaml /openapi.yaml post /api/inboxes/{channelId}/threads/{threadId}/comments
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.1'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/inboxes/{channelId}/threads/{threadId}/comments:
    post:
      tags:
        - Inboxes
      summary: Add an internal comment to a thread
      description: |
        Adds an internal (team-only) comment to the thread, as the acting user,
        the same as commenting in the app. It is never sent to the contact.
        `content` is HTML and is sanitized. Mention markup in it labels the
        thread for the mentioned users and teams, marks it unread for them and
        notifies them. Mentioned contacts and location cards are related to the
        thread.

        The acting user is the delegate token's own user. With an API key or
        partner token, name one in `userId`. Guests cannot comment.
      operationId: addInboxThreadComment
      parameters:
        - name: channelId
          in: path
          required: true
          schema:
            type: string
          description: External channel meta ID (`meta.id`) of the inbox.
        - name: threadId
          in: path
          required: true
          schema:
            type: string
          description: Thread id from the threads list.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - content
              properties:
                content:
                  type: string
                  minLength: 1
                  maxLength: 50000
                  description: Comment body, HTML.
                userId:
                  type: string
                  description: >-
                    Acting user (comment author). Required with an API key or
                    partner token.
      responses:
        '201':
          description: Comment added.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      threadId:
                        type: string
                      commentId:
                        type: string
        '400':
          description: Invalid body or missing `userId`.
        '401':
          description: The acting user is not in the company.
        '403':
          description: No access to this inbox, or the acting user is a guest.
        '404':
          description: Inbox or thread not found, or the acting user cannot see the thread.
      security:
        - ApiKeyHeader: []
        - DelegateToken: []
        - PartnerBearer: []
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    DelegateToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Delegate token issued by the platform. Format: `DelegateToken <token>`'
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````

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