{"_id":"54b417994f25cb1600518d19","user":"543532513513400800a144f4","category":{"_id":"54ad59369219922100751732","version":"54343531bfaa3d0800c4d4af","__v":10,"project":"54343170fa5527080064f449","pages":["54ad5a55f6f5b10b0066dcb7","54ad659a9219922100751754","54ad6e40921992210075176c","54ad7476921992210075178b","54ad7514f6f5b10b0066dceb","54ad91e35ff7ef2a009ce66a","54b407c773abe90b0010709b","54b410d8fed7861600c31e31","54b413dffed7861600c31e3e","54b417994f25cb1600518d19"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-07T16:05:10.498Z","from_sync":false,"order":8,"slug":"quick-links","title":"Quick Links"},"editedParams":true,"parentDoc":null,"project":"54343170fa5527080064f449","version":{"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","__v":28,"forked_from":"54343170fa5527080064f44c","createdAt":"2014-10-07T18:47:13.086Z","releaseDate":"2014-10-07T18:47:13.086Z","categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5","596e6e42c5b53b00509791b1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"__v":1,"editedParams2":true,"updates":["54c7cf9cd0d3360d0081c538"],"next":{"pages":[],"description":""},"createdAt":"2015-01-12T18:51:05.598Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n\"id\": \"54b40f153004843414091435\"\n}","language":"json","status":200,"name":""}]},"method":"post","auth":"required","params":[{"_id":"54b41264f6445c1f0008747b","ref":"","in":"path","required":true,"desc":"The ID of the QuickLink in which this comment is occurring","default":"","type":"string","name":"quicklinkId"},{"_id":"54b41264f6445c1f0008747a","ref":"","in":"path","required":true,"desc":"The ID of the asset the comment is in reference to","default":"","type":"string","name":"assetId"},{"_id":"54b41264f6445c1f00087479","ref":"","in":"body","required":true,"desc":"In seconds, the beginning of the window to which the comment is referencing","default":"","type":"string","name":"startTimeCode"},{"_id":"54b417994f25cb1600518d1a","ref":"","in":"body","required":false,"desc":"In seconds, the beginning of the window to which the comment is referencing","default":"","type":"string","name":"endTimeCode"},{"_id":"54b41264f6445c1f00087478","ref":"","in":"body","required":true,"desc":"The comment","default":"","type":"string","name":"body"}],"url":"/quicklinks/:quicklinkId/assets/:assetId/comments"},"isReference":false,"order":8,"body":"Video assets often require conversations about specific points in the video. This is why we chose to add support for time-coded comments. Time-coded comments allow you to pass in a start and end time to each comment, allowing us to put a comment marker in the timeline of the video while it's playing.\n[block:api-header]\n{\n  \"type\": \"basic\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Permissions\"\n}\n[/block]\nIn order to comment on a QuickLink, commenting must be enabled in the QuickLinks settings. If so, then anyone can comment on a public QuickLink. Private QuickLinks can be commented on by anyone in the audience (anyone who the owner has shared the QuickLink with) of the respective QuickLink.","excerpt":"","slug":"time-coded-comments","type":"endpoint","title":"Time-Coded Comments"}

postTime-Coded Comments


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

quicklinkId:
required
string
The ID of the QuickLink in which this comment is occurring
assetId:
required
string
The ID of the asset the comment is in reference to

Body Params

startTimeCode:
required
string
In seconds, the beginning of the window to which the comment is referencing
endTimeCode:
string
In seconds, the beginning of the window to which the comment is referencing
body:
required
string
The comment

Result Format


Documentation

Video assets often require conversations about specific points in the video. This is why we chose to add support for time-coded comments. Time-coded comments allow you to pass in a start and end time to each comment, allowing us to put a comment marker in the timeline of the video while it's playing. [block:api-header] { "type": "basic" } [/block] [block:api-header] { "type": "basic", "title": "Permissions" } [/block] In order to comment on a QuickLink, commenting must be enabled in the QuickLinks settings. If so, then anyone can comment on a public QuickLink. Private QuickLinks can be commented on by anyone in the audience (anyone who the owner has shared the QuickLink with) of the respective QuickLink.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}