Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444236171.7 KB

Adds a new comment to the specified document version.

post/api/v1/documents/{DocumentId}/versions/{VersionId}/comment

Path parameters

DocumentIdstring required

The ID of the document.

VersionIdstring required

The ID of the document version.

Headers

Authenticationstring password

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Request body

ParentIdstring

The ID of the parent comment.

ThreadIdstring

The ID of the root comment in the thread.

Textstring 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.

NotifyCollaboratorsboolean

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

Response

Success