Logo
Accusoft API Documentation

Add Document Comments

POST {{editor_base_url}}/api/v1/documents/{{documentId}}/actions/addComments

NOTE: This endpoint changes the document and assumes that nothing else (like an editing session or another call to this endpoint) will be making changes to the document at the same time.*

DO NOT call this endpoint if an end user is actively editing the document.
DO NOT make concurrent calls to this endpoint for the same document.

If you do these things, changes to the document may not be applied correctly

https://api.accusoft.com/editor/docs/#api-Documents-addComments

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status





Curl
curl -X POST 'editor_base_url/api/v1/documents/documentId/actions/addComments' -H 'Content-Type: application/json' -d '{"comments":[{"selection":{"startIndex":0,"length":190},"text":"Payment Terms","author":{"displayName":"John Doe"}}]}'

ENDPOINTS