Comments

Update comment

Changed on

Update comment content, tags, or attachments. Authors can edit within the configured 15-minute window unless they have elevated permissions.

put/api/v1/comment/{id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

contentstring required

Updated plain-text content (maximum 15,000 characters).

contentHTMLstring nullable required

Updated HTML content.

Response

OK

_idstring

Comment identifier (24-character hex ObjectId).

documentIDstring

Stable document key for threading and position.

objectIDstring

Associated object ID.

objectCodestring

Associated object type code.

parentIDstring nullable

Parent comment ID for replies.

parentCommentIDstring nullable

Resolved parent comment reference.

typestring

Comment type discriminator.

contentstring

Plain-text content.

contentHTMLstring nullable

HTML content.

isPrivateboolean

Company-scoped visibility flag.

authorIDstring

Author user ID.

authorNamestring

Author display name when available.

customerIdstring

Customer (tenant) identifier.

companyIDstring

Company identifier when applicable.

externalRefIDstring nullable

External correlation ID.

createdAtnumber

Creation timestamp (Unix milliseconds).

lastModifiedAtnumber

Last modification timestamp (Unix milliseconds).

modifiedBystring

User ID of the last modifier.

modifiedboolean

Whether the comment was edited after creation.

editedboolean

Whether the comment content was edited.

deletedboolean

Soft-delete flag.

deletedBystring

User ID that deleted the comment.

deletedDatenumber

Deletion timestamp (Unix milliseconds).

resolvedboolean

Whether the comment thread is resolved.

resolvedBystring

User ID that resolved the comment.

reactionsobject[]

Embedded reaction summaries when present.

Changes