---
title: "POST /api/v1/documents/{DocumentId}/versions/{VersionId}/comment"
method: POST
path: "/api/v1/documents/{DocumentId}/versions/{VersionId}/comment"
---

# POST /api/v1/documents/{DocumentId}/versions/{VersionId}/comment

`POST /api/v1/documents/{DocumentId}/versions/{VersionId}/comment`

Adds a new comment to the specified document version.

## Path parameters

- `DocumentId` string, required
- `VersionId` string, required

## Headers

- `Authentication` string, password

## Request body

- object
  - `ParentId` string — The ID of the parent comment.
  - `ThreadId` string — The ID of the root comment in the thread.
  - `Text` string, password, required — The text of the comment.
  - `Visibility` 'PUBLIC' | 'PRIVATE' — The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
  - `NotifyCollaborators` boolean — Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

## Response `201`

Success

- CreateCommentResponse
  - `Comment` object — The comment that has been created.
    - `CommentId` string, required — The ID of the comment.
    - `ParentId` string — The ID of the parent comment.
    - `ThreadId` string — The ID of the root comment in the thread.
    - `Text` string, password — The text of the comment.
    - `Contributor` object — The details of the user who made the comment.
      - `Id` string — The ID of the user.
      - `Username` string, password — The login name of the user.
      - `EmailAddress` string, password — The email address of the user.
      - `GivenName` string, password — The given name of the user.
      - `Surname` string, password — The surname of the user.
      - `OrganizationId` string — The ID of the organization.
      - `RootFolderId` string — The ID of the root folder.
      - `RecycleBinFolderId` string — The ID of the recycle bin folder.
      - `Status` 'ACTIVE' | 'INACTIVE' | 'PENDING' — The status of the user.
      - `Type` 'USER' | 'ADMIN' | 'POWERUSER' | 'MINIMALUSER' | 'WORKSPACESUSER' — The type of user.
      - `CreatedTimestamp` string, date-time — The time when the user was created.
      - `ModifiedTimestamp` string, date-time — The time when the user was modified.
      - `TimeZoneId` string — The time zone ID of the user.
      - `Locale` 'en' | 'fr' | 'ko' | 'de' | 'es' | 'ja' | 'ru' | 'zh_CN' | 'zh_TW' | 'pt_BR' | 'default' — The locale of the user.
      - `Storage` object — The storage for the user.
        - `StorageUtilizedInBytes` integer — The amount of storage used, in bytes.
        - `StorageRule` object — The storage for a user.
          - `StorageAllocatedInBytes` integer — The amount of storage allocated, in bytes.
          - `StorageType` 'UNLIMITED' | 'QUOTA' — The type of storage.
    - `CreatedTimestamp` string, date-time — The time that the comment was created.
    - `Status` 'DRAFT' | 'PUBLISHED' | 'DELETED' — The status of the comment.
    - `Visibility` 'PUBLIC' | 'PRIVATE' — The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
    - `RecipientId` string — If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

## Other responses

- `480` — EntityNotExistsException
- `481` — ProhibitedStateException
- `482` — UnauthorizedOperationException
- `483` — UnauthorizedResourceAccessException
- `484` — FailedDependencyException
- `485` — ServiceUnavailableException
- `486` — DocumentLockedForCommentsException
- `487` — InvalidCommentOperationException

---

[API](https://skmtc.net/aws/apis/workdocs.md) · [All operations](https://skmtc.net/aws/apis/workdocs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/workdocs/versions/8a533af4e1ef/schema)