POST

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

http://workdocs.{region}.amazonaws.com/api/v1/documents/{DocumentId}/versions/{VersionId}/comment

Adds a new comment to the specified document version.

Access Token Required: API Key

Path Parameters

DocumentIdstringrequired

The ID of the document.

VersionIdstringrequired

The ID of the document version.

Body Params

Textstringrequired

The text of the comment.

ParentIdstring

The ID of the parent comment.

ThreadIdstring

The ID of the root comment in the thread.

Visibilitystring

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/documents/{DocumentId}/versions/{VersionId}/comment' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}