POST
/
v1
/
commentannotations
/
add
curl --request POST \
  --url https://api.velt.dev/v1/commentannotations/add \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '{
  "data": {
    "organizationId": "<string>",
    "documentId": "<string>",
    "commentAnnotations": [
      {
        "location": {
          "id": "<string>",
          "locationName": "<string>"
        },
        "targetElement": {
          "elementId": "<string>",
          "targetText": "<string>",
          "occurrence": 123,
          "selectAllContent": true
        },
        "commentData": [
          {
            "commentText": "<string>",
            "commentHtml": "<string>",
            "from": {},
            "createdAt": 123,
            "lastUpdated": 123
          }
        ],
        "status": {
          "type": {},
          "lightColor": "<string>",
          "svg": "<string>",
          "iconUrl": "<string>"
        },
        "assignedTo": {},
        "context": {},
        "createdAt": 123,
        "lastUpdated": 123,
        "priority": {
          "id": "<string>",
          "color": "<string>",
          "name": "<string>",
          "lightColor": "<string>"
        }
      }
    ]
  }
}'
{
  "result": {
    "status": "success",
    "message": "Comment Annotation addition successful.",
    "data": {
      "annotationId": "yourAnnotationId",
      "commentIds": [
        333130
      ]
    }
  }
}

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://api.velt.dev/v1/commentannotations/add

​
Headers

​
x-velt-api-key
string
required

Your API key.

​
x-velt-auth-token
string
required

Your Auth Token.

​
Body

​
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"
  }
}

{
  "result": {
    "status": "success",
    "message": "Comment Annotation addition successful.",
    "data": {
      "annotationId": "yourAnnotationId",
      "commentIds": [
        333130
      ]
    }
  }
}

Was this page helpful?

Delete Users from GroupsUpdate Comment Annotations