Update a Comment

Update a Comment via its ID, overwriting only the passed key/value pairs

SecurityJWT or OAuth2 or DeveloperToken
Request
path Parameters
comment_id
required
string <uuid>

Comment ID

Example: eefb57e0-79f2-4bc7-9b70-99fbc175175c
Request Body schema: application/json

Comment to create or update

text
required
string

The body of the comment.

annotation
string

Serialized list of geometry and/or drawing data.

Learn more here

page
integer

Page number for a comment (documents only).

pitch
integer
Deprecated

Pitch measurement for the comment (360deg video only).

timestamp
number

Timestamp for the comment, in frames, starting at 0.

Comments can "global" to an asset in which you don't provide the timestamp, or if you're reviewing a "document" like a PDF then you would use page instead of timestamp to identify where the comment belongs.

yaw
integer
Deprecated

Yaw measurement for the comment (360deg video only).

duration
integer

Used to produce range-based comments, this is the duration measured in frames.

private
boolean

Set to true to make your comment a "Team-only Comment" that won't be visible to anonymous reviewers or Collaborators.

Responses
200

Comment success response

Response Schema: application/json
annotation
string
completed
boolean
completed_at
string
completer_id
string <uuid>
has_replies
boolean
id
string <uuid>
like_count
integer
object (User)

User model

owner_id
string <uuid>
text
string
timestamp
integer
401

Unauthorized response

404

Not Found response

put/v2/comments/{comment_id}
Request samples
application/json
{
  • "text": "string"
}
Response samples
application/json
{
  • "annotation": "[...]",
  • "completed": false,
  • "completed_at": "2020-07-15T17:30:00.906305Z",
  • "completer_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "has_replies": true,
  • "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "like_count": 10,
  • "owner": {
    },
  • "owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  • "text": "This is a comment.",
  • "timestamp": 60
}