Update a Comment

PUT

https://api.frame.io/v2/comments/:comment_id

PUT

/v2/comments/:comment_id

1 import requests
2 
3 url = "https://api.frame.io/v2/comments/comment_id"
4 
5 payload = { "text": "string" }
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.put(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "annotation": "[...]",
3   "completed": false,
4   "completed_at": "2020-07-15T17:30:00.906305Z",
5   "completer_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
6   "has_replies": true,
7   "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
8   "like_count": 10,
9   "owner": {
10     "email": "jane@frame.io",
11     "name": "Jane Doe",
12     "account_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
13     "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
14   },
15   "owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
16   "text": "This is a comment.",
17   "timestamp": 60
18 }

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

Authentification

AuthorizationBearer

Authentification bearer de la forme Bearer <token>, où token est votre jeton d’authentification.

Paramètres de chemin

comment_idstringRequis

Requête

Comment to create or update

textstringRequis

The body of the comment.

annotationstringOptionnel

Serialized list of geometry and/or drawing data.

Learn more here

Serialized list of geometry and/or drawing data. Learn more [here](https://developer.frame.io/docs/workflows-assets/working-with-annotations)

pageintegerOptionnel

Page number for a comment (documents only).

timestampdoubleOptionnel

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.

durationintegerOptionnel

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

privatebooleanOptionnel

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

pitchintegerOptionnelDeprecated

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

yawintegerOptionnelDeprecated

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

Réponse

Comment success response

annotationstring

completedboolean

completed_atstring

completer_idstringformat: "uuid"

has_repliesboolean

idstringformat: "uuid"

like_countinteger

ownerobject

User model

owner_idstringformat: "uuid"

textstring

timestampinteger

Erreurs

401

Unauthorized Error

404

Not Found Error