Update Comments

curl --request POST \
  --url https://api.velt.dev/v1/commentannotations/comments/update \
  --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>",
    "annotationId": "<string>",
    "commentIds": [
      123
    ],
    "updatedData": {
      "commentText": "<string>",
      "commentHtml": "<string>",
      "isCommentResolverUsed": true,
      "isCommentTextAvailable": true,
      "from": {},
      "taggedUserContacts": [
        {
          "text": "<string>",
          "userId": "<string>",
          "contact": {
            "email": "<string>",
            "name": "<string>",
            "userId": "<string>"
          }
        }
      ]
    }
  }
}
'

import requests

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

payload = { "data": {
        "organizationId": "<string>",
        "documentId": "<string>",
        "annotationId": "<string>",
        "commentIds": [123],
        "updatedData": {
            "commentText": "<string>",
            "commentHtml": "<string>",
            "isCommentResolverUsed": True,
            "isCommentTextAvailable": True,
            "from": {},
            "taggedUserContacts": [
                {
                    "text": "<string>",
                    "userId": "<string>",
                    "contact": {
                        "email": "<string>",
                        "name": "<string>",
                        "userId": "<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>',
      annotationId: '<string>',
      commentIds: [123],
      updatedData: {
        commentText: '<string>',
        commentHtml: '<string>',
        isCommentResolverUsed: true,
        isCommentTextAvailable: true,
        from: {},
        taggedUserContacts: [
          {
            text: '<string>',
            userId: '<string>',
            contact: {email: '<string>', name: '<string>', userId: '<string>'}
          }
        ]
      }
    }
  })
};

fetch('https://api.velt.dev/v1/commentannotations/comments/update', 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/comments/update",
  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>',
        'annotationId' => '<string>',
        'commentIds' => [
                123
        ],
        'updatedData' => [
                'commentText' => '<string>',
                'commentHtml' => '<string>',
                'isCommentResolverUsed' => true,
                'isCommentTextAvailable' => true,
                'from' => [
                                
                ],
                'taggedUserContacts' => [
                                [
                                                                'text' => '<string>',
                                                                'userId' => '<string>',
                                                                'contact' => [
                                                                                                                                'email' => '<string>',
                                                                                                                                'name' => '<string>',
                                                                                                                                'userId' => '<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/comments/update"

	payload := strings.NewReader("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"annotationId\": \"<string>\",\n    \"commentIds\": [\n      123\n    ],\n    \"updatedData\": {\n      \"commentText\": \"<string>\",\n      \"commentHtml\": \"<string>\",\n      \"isCommentResolverUsed\": true,\n      \"isCommentTextAvailable\": true,\n      \"from\": {},\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}")

	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/comments/update")
  .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    \"annotationId\": \"<string>\",\n    \"commentIds\": [\n      123\n    ],\n    \"updatedData\": {\n      \"commentText\": \"<string>\",\n      \"commentHtml\": \"<string>\",\n      \"isCommentResolverUsed\": true,\n      \"isCommentTextAvailable\": true,\n      \"from\": {},\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}")
  .asString();

require 'uri'
require 'net/http'

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

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    \"annotationId\": \"<string>\",\n    \"commentIds\": [\n      123\n    ],\n    \"updatedData\": {\n      \"commentText\": \"<string>\",\n      \"commentHtml\": \"<string>\",\n      \"isCommentResolverUsed\": true,\n      \"isCommentTextAvailable\": true,\n      \"from\": {},\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}"

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

{
  "result": {
    "status": "success",
    "message": "Comment updated successfully.",
    "data": {
      "607395": {
        "success": true,
        "id": 607395,
        "message": "Updated successfully"
      }
    }
  }
}

POST

commentannotations

comments

update

Update Comments

curl --request POST \
  --url https://api.velt.dev/v1/commentannotations/comments/update \
  --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>",
    "annotationId": "<string>",
    "commentIds": [
      123
    ],
    "updatedData": {
      "commentText": "<string>",
      "commentHtml": "<string>",
      "isCommentResolverUsed": true,
      "isCommentTextAvailable": true,
      "from": {},
      "taggedUserContacts": [
        {
          "text": "<string>",
          "userId": "<string>",
          "contact": {
            "email": "<string>",
            "name": "<string>",
            "userId": "<string>"
          }
        }
      ]
    }
  }
}
'

import requests

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

payload = { "data": {
        "organizationId": "<string>",
        "documentId": "<string>",
        "annotationId": "<string>",
        "commentIds": [123],
        "updatedData": {
            "commentText": "<string>",
            "commentHtml": "<string>",
            "isCommentResolverUsed": True,
            "isCommentTextAvailable": True,
            "from": {},
            "taggedUserContacts": [
                {
                    "text": "<string>",
                    "userId": "<string>",
                    "contact": {
                        "email": "<string>",
                        "name": "<string>",
                        "userId": "<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>',
      annotationId: '<string>',
      commentIds: [123],
      updatedData: {
        commentText: '<string>',
        commentHtml: '<string>',
        isCommentResolverUsed: true,
        isCommentTextAvailable: true,
        from: {},
        taggedUserContacts: [
          {
            text: '<string>',
            userId: '<string>',
            contact: {email: '<string>', name: '<string>', userId: '<string>'}
          }
        ]
      }
    }
  })
};

fetch('https://api.velt.dev/v1/commentannotations/comments/update', 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/comments/update",
  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>',
        'annotationId' => '<string>',
        'commentIds' => [
                123
        ],
        'updatedData' => [
                'commentText' => '<string>',
                'commentHtml' => '<string>',
                'isCommentResolverUsed' => true,
                'isCommentTextAvailable' => true,
                'from' => [
                                
                ],
                'taggedUserContacts' => [
                                [
                                                                'text' => '<string>',
                                                                'userId' => '<string>',
                                                                'contact' => [
                                                                                                                                'email' => '<string>',
                                                                                                                                'name' => '<string>',
                                                                                                                                'userId' => '<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/comments/update"

	payload := strings.NewReader("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"annotationId\": \"<string>\",\n    \"commentIds\": [\n      123\n    ],\n    \"updatedData\": {\n      \"commentText\": \"<string>\",\n      \"commentHtml\": \"<string>\",\n      \"isCommentResolverUsed\": true,\n      \"isCommentTextAvailable\": true,\n      \"from\": {},\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}")

	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/comments/update")
  .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    \"annotationId\": \"<string>\",\n    \"commentIds\": [\n      123\n    ],\n    \"updatedData\": {\n      \"commentText\": \"<string>\",\n      \"commentHtml\": \"<string>\",\n      \"isCommentResolverUsed\": true,\n      \"isCommentTextAvailable\": true,\n      \"from\": {},\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}")
  .asString();

require 'uri'
require 'net/http'

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

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    \"annotationId\": \"<string>\",\n    \"commentIds\": [\n      123\n    ],\n    \"updatedData\": {\n      \"commentText\": \"<string>\",\n      \"commentHtml\": \"<string>\",\n      \"isCommentResolverUsed\": true,\n      \"isCommentTextAvailable\": true,\n      \"from\": {},\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}"

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

{
  "result": {
    "status": "success",
    "message": "Comment updated successfully.",
    "data": {
      "607395": {
        "success": true,
        "id": 607395,
        "message": "Updated successfully"
      }
    }
  }
}

Use this API to update comments within a specific CommentAnnotation.

Endpoint

POST https://api.velt.dev/v1/commentannotations/comments/update

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

annotationId

string

required

Comment Annotation ID

commentIds

number[]

required

Comment IDs

updatedData

Object

required

Comment data

Show properties

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

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

string

required

Email of the tagged user

name

string

required

Name of the tagged user

userId

string

required

User ID of the tagged user

Example Requests

Update comment in a CommentAnnotation by organizationId, documentId, annotationId and commentId

{
  "data": {
    "organizationId": "yourOrganizationId",
    "documentId": "yourDocumentId",
    "annotationId": "yourAnnotationId",
    "commentIds": [
      153783,
      607395
    ],
    "updatedData": {
      "commentText": "Sample Updated Comment",
      "commentHtml": "<div>Hello Updated</div>"
    }
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Comment updated successfully.",
    "data": {
      "607395": {
        "success": true,
        "id": 607395,
        "message": "Updated successfully"
      }
    }
  }
}

Failure Response

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

{
  "result": {
    "status": "success",
    "message": "Comment updated successfully.",
    "data": {
      "607395": {
        "success": true,
        "id": 607395,
        "message": "Updated successfully"
      }
    }
  }
}

Get Comments Delete Comments

⌘I

​Endpoint

​Headers

​Body

​Params

​Example Requests

​Update comment in a CommentAnnotation by organizationId, documentId, annotationId and commentId

​Response

​Success Response

​Failure Response

Endpoint

Headers

Body

Params

Example Requests

Update comment in a CommentAnnotation by organizationId, documentId, annotationId and commentId

Response

Success Response

Failure Response