Skip to main content
PUT
Update Comment

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

comment_id
string<uuid>
required

The ID of the comment to update

Body

application/json

API request schema for updating a comment

text
string
required

Updated comment text

mentions
MentionCreateData · object[]

User mentions in the comment

attachment_ids
string<uuid>[]

Attachment IDs to link to the comment (replaces existing)

timestamp
number | null

Video timestamp in seconds (negative to clear)

duration
number | null

Duration in seconds for range comments (negative to clear)

private
boolean | null

Whether this comment is private/internal (only for root comments)

Response

Successful Response

API response schema for a single comment with nested replies, reactions, mentions, and attachments

id
string<uuid>
required
resource_id
string<uuid>
required
asset_id
string<uuid>
required
node_id
string<uuid> | null
required
canvas_position
CanvasPosition · object | null
required

Canvas pin position in flow coordinates (absolute, or relative to the node origin when node_id is set)

user_id
string<uuid> | null
required
parent_id
string<uuid> | null
required
text
string
required
timestamp
number | null
required
duration
number | null
required
anchor_position
AnchorPosition · object | null
required

Position for anchored comments on assets (x/y as percentages 0-100)

annotation
(PenPath · object | LinePath · object | ArrowPath · object | BoxPath · object)[] | null
required

Pen/freehand drawing path

page
integer | null
required
text_highlight
TextHighlight · object | null
required

Data for a text highlight comment

is_resolved
boolean
required
private
boolean
required
number
integer | null
required
user
UserInfo · object | null
required

Lightweight user information for API responses

replies
Replies · array
required
reactions
ReactionGroup · object[]
required
mentions
MentionInfo · object[]
required
attachments
SignedAttachment · object[]
required
created
string<date-time>
required
updated
string<date-time>
required