Import comments
curl --request POST \
--url https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-External-User-ID: <x-external-user-id>' \
--data '
{
"comments": [
{
"author": {
"email": "<string>",
"externalUserId": "<string>",
"displayName": "<string>",
"sourceUserId": "<string>",
"sourceRole": "<string>",
"role": "author"
},
"externalCommentId": "<string>",
"content": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": {
"type": "image",
"xRatio": 0.5,
"yRatio": 0.5
},
"parentCommentId": "<string>",
"parentExternalCommentId": "<string>"
}
]
}
'import requests
url = "https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments"
payload = { "comments": [
{
"author": {
"email": "<string>",
"externalUserId": "<string>",
"displayName": "<string>",
"sourceUserId": "<string>",
"sourceRole": "<string>",
"role": "author"
},
"externalCommentId": "<string>",
"content": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": {
"type": "image",
"xRatio": 0.5,
"yRatio": 0.5
},
"parentCommentId": "<string>",
"parentExternalCommentId": "<string>"
}
] }
headers = {
"X-External-User-ID": "<x-external-user-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-External-User-ID': '<x-external-user-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
comments: [
{
author: {
email: '<string>',
externalUserId: '<string>',
displayName: '<string>',
sourceUserId: '<string>',
sourceRole: '<string>',
role: 'author'
},
externalCommentId: '<string>',
content: '<string>',
createdAt: '2023-11-07T05:31:56Z',
uploadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
location: {type: 'image', xRatio: 0.5, yRatio: 0.5},
parentCommentId: '<string>',
parentExternalCommentId: '<string>'
}
]
})
};
fetch('https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments', 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://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments",
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([
'comments' => [
[
'author' => [
'email' => '<string>',
'externalUserId' => '<string>',
'displayName' => '<string>',
'sourceUserId' => '<string>',
'sourceRole' => '<string>',
'role' => 'author'
],
'externalCommentId' => '<string>',
'content' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'uploadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'location' => [
'type' => 'image',
'xRatio' => 0.5,
'yRatio' => 0.5
],
'parentCommentId' => '<string>',
'parentExternalCommentId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-External-User-ID: <x-external-user-id>"
],
]);
$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://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments"
payload := strings.NewReader("{\n \"comments\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"sourceUserId\": \"<string>\",\n \"sourceRole\": \"<string>\",\n \"role\": \"author\"\n },\n \"externalCommentId\": \"<string>\",\n \"content\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": {\n \"type\": \"image\",\n \"xRatio\": 0.5,\n \"yRatio\": 0.5\n },\n \"parentCommentId\": \"<string>\",\n \"parentExternalCommentId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-External-User-ID", "<x-external-user-id>")
req.Header.Add("Authorization", "Bearer <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://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments")
.header("X-External-User-ID", "<x-external-user-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"comments\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"sourceUserId\": \"<string>\",\n \"sourceRole\": \"<string>\",\n \"role\": \"author\"\n },\n \"externalCommentId\": \"<string>\",\n \"content\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": {\n \"type\": \"image\",\n \"xRatio\": 0.5,\n \"yRatio\": 0.5\n },\n \"parentCommentId\": \"<string>\",\n \"parentExternalCommentId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-External-User-ID"] = '<x-external-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"comments\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"sourceUserId\": \"<string>\",\n \"sourceRole\": \"<string>\",\n \"role\": \"author\"\n },\n \"externalCommentId\": \"<string>\",\n \"content\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": {\n \"type\": \"image\",\n \"xRatio\": 0.5,\n \"yRatio\": 0.5\n },\n \"parentCommentId\": \"<string>\",\n \"parentExternalCommentId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"externalCommentId": "<string>",
"status": "created",
"threadId": "<string>",
"commentId": "<string>",
"reason": "already_imported",
"authorResolution": "member",
"error": {
"code": "AUTHOR_UNAVAILABLE",
"message": "<string>"
}
}
],
"summary": {
"created": 123,
"skipped": 123,
"rejected": 123
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Evaluation
Import comments
Import external review comments, replies, and action responses onto the latest version. Returns per-item results in request order. Send externalCommentId on every item for safe sequential retries; concurrent duplicate requests may race. Location anchors must already be collapsed: send the centre point of a region, and the start timestamp of a time range. Omit location entirely for an unanchored (sidebar) thread. Newly imported comments may not appear in GET immediately — allow a short delay before using GET to resolve parentCommentId.
POST
/
v1
/
promotions
/
{promotionId}
/
versions
/
{versionId}
/
comments
Import comments
curl --request POST \
--url https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-External-User-ID: <x-external-user-id>' \
--data '
{
"comments": [
{
"author": {
"email": "<string>",
"externalUserId": "<string>",
"displayName": "<string>",
"sourceUserId": "<string>",
"sourceRole": "<string>",
"role": "author"
},
"externalCommentId": "<string>",
"content": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": {
"type": "image",
"xRatio": 0.5,
"yRatio": 0.5
},
"parentCommentId": "<string>",
"parentExternalCommentId": "<string>"
}
]
}
'import requests
url = "https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments"
payload = { "comments": [
{
"author": {
"email": "<string>",
"externalUserId": "<string>",
"displayName": "<string>",
"sourceUserId": "<string>",
"sourceRole": "<string>",
"role": "author"
},
"externalCommentId": "<string>",
"content": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"uploadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": {
"type": "image",
"xRatio": 0.5,
"yRatio": 0.5
},
"parentCommentId": "<string>",
"parentExternalCommentId": "<string>"
}
] }
headers = {
"X-External-User-ID": "<x-external-user-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-External-User-ID': '<x-external-user-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
comments: [
{
author: {
email: '<string>',
externalUserId: '<string>',
displayName: '<string>',
sourceUserId: '<string>',
sourceRole: '<string>',
role: 'author'
},
externalCommentId: '<string>',
content: '<string>',
createdAt: '2023-11-07T05:31:56Z',
uploadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
location: {type: 'image', xRatio: 0.5, yRatio: 0.5},
parentCommentId: '<string>',
parentExternalCommentId: '<string>'
}
]
})
};
fetch('https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments', 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://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments",
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([
'comments' => [
[
'author' => [
'email' => '<string>',
'externalUserId' => '<string>',
'displayName' => '<string>',
'sourceUserId' => '<string>',
'sourceRole' => '<string>',
'role' => 'author'
],
'externalCommentId' => '<string>',
'content' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'uploadId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'location' => [
'type' => 'image',
'xRatio' => 0.5,
'yRatio' => 0.5
],
'parentCommentId' => '<string>',
'parentExternalCommentId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-External-User-ID: <x-external-user-id>"
],
]);
$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://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments"
payload := strings.NewReader("{\n \"comments\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"sourceUserId\": \"<string>\",\n \"sourceRole\": \"<string>\",\n \"role\": \"author\"\n },\n \"externalCommentId\": \"<string>\",\n \"content\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": {\n \"type\": \"image\",\n \"xRatio\": 0.5,\n \"yRatio\": 0.5\n },\n \"parentCommentId\": \"<string>\",\n \"parentExternalCommentId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-External-User-ID", "<x-external-user-id>")
req.Header.Add("Authorization", "Bearer <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://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments")
.header("X-External-User-ID", "<x-external-user-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"comments\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"sourceUserId\": \"<string>\",\n \"sourceRole\": \"<string>\",\n \"role\": \"author\"\n },\n \"externalCommentId\": \"<string>\",\n \"content\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": {\n \"type\": \"image\",\n \"xRatio\": 0.5,\n \"yRatio\": 0.5\n },\n \"parentCommentId\": \"<string>\",\n \"parentExternalCommentId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-External-User-ID"] = '<x-external-user-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"comments\": [\n {\n \"author\": {\n \"email\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"displayName\": \"<string>\",\n \"sourceUserId\": \"<string>\",\n \"sourceRole\": \"<string>\",\n \"role\": \"author\"\n },\n \"externalCommentId\": \"<string>\",\n \"content\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"uploadId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"location\": {\n \"type\": \"image\",\n \"xRatio\": 0.5,\n \"yRatio\": 0.5\n },\n \"parentCommentId\": \"<string>\",\n \"parentExternalCommentId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"externalCommentId": "<string>",
"status": "created",
"threadId": "<string>",
"commentId": "<string>",
"reason": "already_imported",
"authorResolution": "member",
"error": {
"code": "AUTHOR_UNAVAILABLE",
"message": "<string>"
}
}
],
"summary": {
"created": 123,
"skipped": 123,
"rejected": 123
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "<string>",
"details": [
{
"type": "field_error",
"field": "<string>",
"message": "<string>"
}
]
},
"correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
API key passed as Bearer token
Headers
Identifier of the acting user in the calling system (e.g. a Workfront user id). Recorded against every audited action this request performs.
Acting user email. Only meaningful on keys with act-on-behalf enabled, where it is resolved to the matching Adclear user and is mandatory on writes. Ignored on ordinary keys.
Body
application/json
Required array length:
1 - 100 elementsShow child attributes
Show child attributes
Was this page helpful?