Add Comment Annotations

POST /v1/commentannotations/add

Add Comment Annotations

cURL

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": [
      {
        "annotationId": "<string>",
        "location": {
          "id": "<string>",
          "locationName": "<string>"
        },
        "targetElement": {
          "elementId": "<string>",
          "targetText": "<string>",
          "occurrence": 123,
          "selectAllContent": true
        },
        "commentData": [
          {
            "commentId": 123,
            "commentText": "<string>",
            "commentHtml": "<string>",
            "isCommentResolverUsed": true,
            "isCommentTextAvailable": true,
            "from": {},
            "createdAt": 123,
            "lastUpdated": 123,
            "taggedUserContacts": [
              {
                "text": "<string>",
                "userId": "<string>",
                "contact": {
                  "email": "<string>",
                  "name": "<string>",
                  "userId": "<string>"
                }
              }
            ]
          }
        ],
        "status": {
          "id": "<string>",
          "name": "<string>",
          "type": {},
          "color": "<string>",
          "lightColor": "<string>",
          "svg": "<string>",
          "iconUrl": "<string>"
        },
        "assignedTo": {},
        "context": {},
        "createdAt": 123,
        "lastUpdated": 123,
        "priority": {
          "id": "<string>",
          "color": "<string>",
          "name": "<string>",
          "lightColor": "<string>"
        }
      }
    ]
  }
}
'

import requests

url = "https://api.velt.dev/v1/commentannotations/add"

payload = { "data": {
        "organizationId": "<string>",
        "documentId": "<string>",
        "commentAnnotations": [
            {
                "annotationId": "<string>",
                "location": {
                    "id": "<string>",
                    "locationName": "<string>"
                },
                "targetElement": {
                    "elementId": "<string>",
                    "targetText": "<string>",
                    "occurrence": 123,
                    "selectAllContent": True
                },
                "commentData": [
                    {
                        "commentId": 123,
                        "commentText": "<string>",
                        "commentHtml": "<string>",
                        "isCommentResolverUsed": True,
                        "isCommentTextAvailable": True,
                        "from": {},
                        "createdAt": 123,
                        "lastUpdated": 123,
                        "taggedUserContacts": [
                            {
                                "text": "<string>",
                                "userId": "<string>",
                                "contact": {
                                    "email": "<string>",
                                    "name": "<string>",
                                    "userId": "<string>"
                                }
                            }
                        ]
                    }
                ],
                "status": {
                    "id": "<string>",
                    "name": "<string>",
                    "type": {},
                    "color": "<string>",
                    "lightColor": "<string>",
                    "svg": "<string>",
                    "iconUrl": "<string>"
                },
                "assignedTo": {},
                "context": {},
                "createdAt": 123,
                "lastUpdated": 123,
                "priority": {
                    "id": "<string>",
                    "color": "<string>",
                    "name": "<string>",
                    "lightColor": "<string>"
                }
            }
        ]
    } }
headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      organizationId: '<string>',
      documentId: '<string>',
      commentAnnotations: [
        {
          annotationId: '<string>',
          location: {id: '<string>', locationName: '<string>'},
          targetElement: {
            elementId: '<string>',
            targetText: '<string>',
            occurrence: 123,
            selectAllContent: true
          },
          commentData: [
            {
              commentId: 123,
              commentText: '<string>',
              commentHtml: '<string>',
              isCommentResolverUsed: true,
              isCommentTextAvailable: true,
              from: {},
              createdAt: 123,
              lastUpdated: 123,
              taggedUserContacts: [
                {
                  text: '<string>',
                  userId: '<string>',
                  contact: {email: '<string>', name: '<string>', userId: '<string>'}
                }
              ]
            }
          ],
          status: {
            id: '<string>',
            name: '<string>',
            type: {},
            color: '<string>',
            lightColor: '<string>',
            svg: '<string>',
            iconUrl: '<string>'
          },
          assignedTo: {},
          context: {},
          createdAt: 123,
          lastUpdated: 123,
          priority: {id: '<string>', color: '<string>', name: '<string>', lightColor: '<string>'}
        }
      ]
    }
  })
};

fetch('https://api.velt.dev/v1/commentannotations/add', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.velt.dev/v1/commentannotations/add",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'organizationId' => '<string>',
        'documentId' => '<string>',
        'commentAnnotations' => [
                [
                                'annotationId' => '<string>',
                                'location' => [
                                                                'id' => '<string>',
                                                                'locationName' => '<string>'
                                ],
                                'targetElement' => [
                                                                'elementId' => '<string>',
                                                                'targetText' => '<string>',
                                                                'occurrence' => 123,
                                                                'selectAllContent' => true
                                ],
                                'commentData' => [
                                                                [
                                                                                                                                'commentId' => 123,
                                                                                                                                'commentText' => '<string>',
                                                                                                                                'commentHtml' => '<string>',
                                                                                                                                'isCommentResolverUsed' => true,
                                                                                                                                'isCommentTextAvailable' => true,
                                                                                                                                'from' => [
                                                                                                                                                                                                                                                                
                                                                                                                                ],
                                                                                                                                'createdAt' => 123,
                                                                                                                                'lastUpdated' => 123,
                                                                                                                                'taggedUserContacts' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'text' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'userId' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'contact' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'email' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'name' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'userId' => '<string>'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ],
                                'status' => [
                                                                'id' => '<string>',
                                                                'name' => '<string>',
                                                                'type' => [
                                                                                                                                
                                                                ],
                                                                'color' => '<string>',
                                                                'lightColor' => '<string>',
                                                                'svg' => '<string>',
                                                                'iconUrl' => '<string>'
                                ],
                                'assignedTo' => [
                                                                
                                ],
                                'context' => [
                                                                
                                ],
                                'createdAt' => 123,
                                'lastUpdated' => 123,
                                'priority' => [
                                                                'id' => '<string>',
                                                                'color' => '<string>',
                                                                'name' => '<string>',
                                                                'lightColor' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.velt.dev/v1/commentannotations/add"

	payload := strings.NewReader("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"commentAnnotations\": [\n      {\n        \"annotationId\": \"<string>\",\n        \"location\": {\n          \"id\": \"<string>\",\n          \"locationName\": \"<string>\"\n        },\n        \"targetElement\": {\n          \"elementId\": \"<string>\",\n          \"targetText\": \"<string>\",\n          \"occurrence\": 123,\n          \"selectAllContent\": true\n        },\n        \"commentData\": [\n          {\n            \"commentId\": 123,\n            \"commentText\": \"<string>\",\n            \"commentHtml\": \"<string>\",\n            \"isCommentResolverUsed\": true,\n            \"isCommentTextAvailable\": true,\n            \"from\": {},\n            \"createdAt\": 123,\n            \"lastUpdated\": 123,\n            \"taggedUserContacts\": [\n              {\n                \"text\": \"<string>\",\n                \"userId\": \"<string>\",\n                \"contact\": {\n                  \"email\": \"<string>\",\n                  \"name\": \"<string>\",\n                  \"userId\": \"<string>\"\n                }\n              }\n            ]\n          }\n        ],\n        \"status\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"type\": {},\n          \"color\": \"<string>\",\n          \"lightColor\": \"<string>\",\n          \"svg\": \"<string>\",\n          \"iconUrl\": \"<string>\"\n        },\n        \"assignedTo\": {},\n        \"context\": {},\n        \"createdAt\": 123,\n        \"lastUpdated\": 123,\n        \"priority\": {\n          \"id\": \"<string>\",\n          \"color\": \"<string>\",\n          \"name\": \"<string>\",\n          \"lightColor\": \"<string>\"\n        }\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.velt.dev/v1/commentannotations/add")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"commentAnnotations\": [\n      {\n        \"annotationId\": \"<string>\",\n        \"location\": {\n          \"id\": \"<string>\",\n          \"locationName\": \"<string>\"\n        },\n        \"targetElement\": {\n          \"elementId\": \"<string>\",\n          \"targetText\": \"<string>\",\n          \"occurrence\": 123,\n          \"selectAllContent\": true\n        },\n        \"commentData\": [\n          {\n            \"commentId\": 123,\n            \"commentText\": \"<string>\",\n            \"commentHtml\": \"<string>\",\n            \"isCommentResolverUsed\": true,\n            \"isCommentTextAvailable\": true,\n            \"from\": {},\n            \"createdAt\": 123,\n            \"lastUpdated\": 123,\n            \"taggedUserContacts\": [\n              {\n                \"text\": \"<string>\",\n                \"userId\": \"<string>\",\n                \"contact\": {\n                  \"email\": \"<string>\",\n                  \"name\": \"<string>\",\n                  \"userId\": \"<string>\"\n                }\n              }\n            ]\n          }\n        ],\n        \"status\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"type\": {},\n          \"color\": \"<string>\",\n          \"lightColor\": \"<string>\",\n          \"svg\": \"<string>\",\n          \"iconUrl\": \"<string>\"\n        },\n        \"assignedTo\": {},\n        \"context\": {},\n        \"createdAt\": 123,\n        \"lastUpdated\": 123,\n        \"priority\": {\n          \"id\": \"<string>\",\n          \"color\": \"<string>\",\n          \"name\": \"<string>\",\n          \"lightColor\": \"<string>\"\n        }\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v1/commentannotations/add")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"commentAnnotations\": [\n      {\n        \"annotationId\": \"<string>\",\n        \"location\": {\n          \"id\": \"<string>\",\n          \"locationName\": \"<string>\"\n        },\n        \"targetElement\": {\n          \"elementId\": \"<string>\",\n          \"targetText\": \"<string>\",\n          \"occurrence\": 123,\n          \"selectAllContent\": true\n        },\n        \"commentData\": [\n          {\n            \"commentId\": 123,\n            \"commentText\": \"<string>\",\n            \"commentHtml\": \"<string>\",\n            \"isCommentResolverUsed\": true,\n            \"isCommentTextAvailable\": true,\n            \"from\": {},\n            \"createdAt\": 123,\n            \"lastUpdated\": 123,\n            \"taggedUserContacts\": [\n              {\n                \"text\": \"<string>\",\n                \"userId\": \"<string>\",\n                \"contact\": {\n                  \"email\": \"<string>\",\n                  \"name\": \"<string>\",\n                  \"userId\": \"<string>\"\n                }\n              }\n            ]\n          }\n        ],\n        \"status\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"type\": {},\n          \"color\": \"<string>\",\n          \"lightColor\": \"<string>\",\n          \"svg\": \"<string>\",\n          \"iconUrl\": \"<string>\"\n        },\n        \"assignedTo\": {},\n        \"context\": {},\n        \"createdAt\": 123,\n        \"lastUpdated\": 123,\n        \"priority\": {\n          \"id\": \"<string>\",\n          \"color\": \"<string>\",\n          \"name\": \"<string>\",\n          \"lightColor\": \"<string>\"\n        }\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

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

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

Show properties

organizationId · string · required

Organization ID

documentId · string · required

Document ID

commentAnnotations · Object[] · required

Show properties

annotationId · string

Custom Annotation ID. If not provided, Velt will generate a unique ID for the annotation.

location · Object

Show properties

id · string · required

Location ID

locationName · string

Location Name

targetElement · Object

Target Element

Show properties

elementId · string

Element DOM Id

targetText · string

Target Text. Provide this if you want to add comment annotation on the provided text content.

occurrence · number

Occurrence. Provide this if you want to add comment annotation on a text content.

selectAllContent · boolean

Select All Content. Provide this if you want to select and add comment annotation on the entire text content of the target elementId.

commentData · Object[] · required

Array of Comment Data

Show properties

commentId · number

Custom Comment ID. If not provided, Velt will generate a unique ID for the comment.

commentText · string

Comment content in plain text string

commentHtml · string

Comment content in HTML string

isCommentResolverUsed · boolean

Use this for self-hosting comments data. Set this as true if you are comments resolver data provider in the SDK.

isCommentTextAvailable · boolean

Use this for self-hosting comments data. Set this as true if this comment will have text content. Sometimes, comments might only have attachments and in that case, set this as false.

from · User · required

User object from whom the comment is added

createdAt · number

Created At timestamp (in milliseconds since epoch).

lastUpdated · number

Last Updated timestamp (in milliseconds since epoch).

taggedUserContacts · Object[]

Array of tagged user contacts

Show properties

text · string · required

Display text of the tagged user (e.g. “@Username”)

userId · string · required

User ID of the tagged user

contact · Object · required

Show properties

email · string · required

Email of the tagged user

name · string · required

Name of the tagged user

userId · string · required

User ID of the tagged user

status · Status

Status

Show properties

id · string · required

Status ID

name · string · required

Status Name

type · 'default' | 'ongoing' | 'terminal' · required

Type.

color · string · required

Text and comment pin color

lightColor · string · required

Background color on the status indicator

svg · string

Raw SVG of the icon. Either svg or iconUrl is required.

iconUrl · string

Icon URL. Either svg or iconUrl is required.

assignedTo · User

User object to whom the comment is assigned

context · Object

Custom key/value metadata object

createdAt · number

Created At timestamp (in milliseconds since epoch).

lastUpdated · number

Last Updated timestamp (in milliseconds since epoch).

priority · Object

Priority

Show properties

id · string · required

Priority ID

color · string · required

Priority Color

name · string · required

Priority Name

lightColor · string · required

Priority Light Color

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>Sample Comment</div>",
            "from": {
              "userId": "yourUserId",
              "name": "yourUserName",
              "email": "yourUserEmail",
            }
          }
        ]
      }
    ]
  }
}

Response

Success Response

{
   "result": {
       "status": "success",
       "message": "Comment Annotation(s) added 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(s) added successfully.",
       "data": {
           "-O0mpUziLcBwzREvZKs6": {
               "success": true,
               "annotationId": "-O0mpUziLcBwzREvZKs6",
               "commentIds": [
                   126535
               ],
               "message": "Added Successfully"
           }
       }
   }
}