Create Comment Tier 4

POST/api/files/:id/commentsCopied!

Creates a comment or a reply to an existing comment.

Example

SDKCLIcURL

const comment = await client.comments.createForFile("FX1234567890ABCD", {
  content: "Looks great, approved.",
  anchor: 12000,
  duration: 3000,
  parent: { id: "0efee6f8-5829-41c9-bb4d-90dd7e72cc58" },
});

bash

youvico comment create \
  --file FX1234567890ABCD \
  --content "Looks great, approved." \
  --anchor 12000 \
  --duration 3000 \
  --parent 0efee6f8-5829-41c9-bb4d-90dd7e72cc58

bash

curl -X POST 'https://api.youvico.com/api/files/FX1234567890ABCD/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "content": "Looks great, approved.", "anchor": 12000, "duration": 3000, "parent": { "id": "0efee6f8-5829-41c9-bb4d-90dd7e72cc58" } }'

json

{
  "data": {
    "id": "2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6"
  }
}

Request

Path

idstringrequired

File ID

Body

contentstring

Maximum 2000 characters

Comment text

anchornumber

0 or greater

Video timestamp in milliseconds, or page number starting from 1 for documents

durationnumber

0 or greater

Duration in the same unit as anchor

parentobject

Parent comment object

parent.idstringrequired

Parent comment ID

Example: 0efee6f8-5829-41c9-bb4d-90dd7e72cc58

attachmentsarray

1-10 items

Uploaded comment attachments to attach to the comment

attachments[].idstringrequired

Comment attachment ID

Example: CA1234567890ABCD

INFO

Provide at least one of content, anchor, or attachments. duration can be provided only when anchor is present.

INFO

Each attachment ID must be unique and refer to a completed, unattached upload started by the same user for this file.

WARNING

Replies to replies are not allowed. parent.id must point to a top-level comment.

Response

Returns 201 Created.

dataobject

Created comment

data.idstring

ID of the created comment

Example: 2fb4e60b-0d9a-46f3-a4dc-cb9fe8ad9be6

Create Comment Tier 4 ​

Example ​

Request ​

Path ​