POST
/

Use this API to add comment annotations to a document within an organization.

  • You can add comments on an elemement, text or page.
  • You can provide HTML or text content.
  • Additional filters can be applied using location IDs.

​
Endpoint

POST https://addcommentannotations.api.velt.dev/

​
Headers

x-velt-api-key
string
required

Your API key.

x-velt-auth-token
string
required

Your Auth Token.

​
Body Example

​
Params

data
Object
required

​
Example Requests

​
Add comment annotation by organizationId, documentId and location

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "commentAnnotations": [
      {
        "location": {
          "id": "yourLocationId",
          "locationName": "yourLocationName"
        },
        "targetElement": {
          "elementId": "yourElementId",
          "targetText": "Your Target Text",
          "occurrence": 1,
          "selectAllContent": false
        },
        "commentData": [
          {
            "commentText": "Sample Comment",
            "commentHtml": "<div>Hello</div>",
            "from": {
              "userId": "yourUserId",
              "name": "yourUserName",
              "email": "yourUserEmail",
            }
          }
        ]
      }
    ]
  }
}

​
Response

​
Success Response

{
   "result": {
       "status": "success",
       "message": "Comment Annotation addition successfully.",
       "data": {
           "-O0mpUziLcBwzREvZKs6": {
               "success": true,
               "annotationId": "-O0mpUziLcBwzREvZKs6",
               "commentIds": [
                   126535
               ],
               "message": "Added Successfully"
           }
       }
   }
}

​
Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

Was this page helpful?

Delete Users from GroupsUpdate Comment Annotations