Comments

Overview

Communication over the proofs is done via comments and replies function inside Proof Viewer tool. 


Field

Description

Read-only

id

Unique ID of a comment.

parent_comment_id

Either null or unique ID of the parent proof.

 

proof_id

Unique ID of a Proof

 

comment

Text of the comment.

'Some text'

 

sequence

Number of the comment/reply posted under the proof. The first digit represents comment number inside the proof and the second one is the reply number.

1 / 2.1  / 6.18

created-at

Date of the comment creation.

'2012-02-22T02:06:58.147Z'

reviewer

Author of the comment. If a user from another tenant or a non-user made the comment, the user ID will be null. Can be only set during comment creation.

[{ reviewer-id: 'reviewer-id', email: 'name@domain.com'}]

location

Loaction of the comment.
[{ page: 1 / null, start-time: 'hh:mm:ss.SSS' / null, end-time: 'hh:mm:ss.SSS' / null}]

 

likes

Lists all the reviewers who liked the comment.
[{ reviewer-id: 'reviewer-id', email: 'name@domain.com'}, ...]

replies

null / [{this comment object}, {this comment object}, ...}]

attachments

null / [{file-name='fix.pdf' download-path='https://...'}, ...]

 

deleted

false / true

Get proof comments

Method Details
HTTP methods GET
Response format json
Requires authentication Yes
Rate limited Yes

GET /v1/proofs/{id}/comments

Returns information about all comments for a specific proof.

Required parameters How to use Description
API Token apikey=[key] query parameter Used to authenticate the request
Proof ID Used in the request URL (see above) Unique identifier of a specific proof version

Create a comment/reply

Method Details
HTTP methods POST
Response format json
Requires authentication Yes
Rate limited Yes

POST v1/proofs/{id}/comments

A method used for adding comments or replies to a proof. 

If one of the following fields is provided make the comment or reply as them, otherwise make the comment as the person performing the API action:

Field Value
reviewer ID of the reviewer performing the action. Should be provided in the request body

Validation: 

  • Ensure the person making the comment has Comment rights
  • If a different reviewer is specified then the logged in user, ensure the logged in user can see the proof
  • Ensure the location is valid - page or time
 Required parameters  How to use  Description
API Token apikey=[key] query parameter Used to authenticate the request
Proof ID Used in the request URL  Unique identifier of a specific proof version
 comment Used in the request body  For classic comment
 location Used in the request body  For static proof comment location should be a page. For audio/video it should be start-time and end-time
Optional parameters  How to use  Description
 parent_comment_id Used in the request body  Comment added with the parent ID parameter is handled as a reply.

Like/Unlike comment

Method Details
HTTP methods POST
Response format json
Requires authentication Yes
Rate limited Yes

POST v1/proofs/{id}/comments/comment-id/like

API method to like or unlike a comment or reply.

If the following field is provided make like as the reviewer otherwise, like as the person performing the API action:

Field Value
reviewer_id ID of the reviewer performing the action. Should be provided in the request body
like Used in the request body

Validation:

  • Ensure the person liking the comment has Comment rights on the proof
  • If a different reviewer is specified than the logged in user, ensure the logged in user can see the proof

Response:

  • The comment object