Start a comment thread on a file, site page, order, or asset. The comment is attributed to the API key's creator.
curl --request POST \
--url https://api.replo.app/v1/comment-threads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Replo-Api-Version: <replo-api-version>' \
--data '
{
"target": {
"kind": "file",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"body": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"anchor": {
"type": "none"
}
}
'import requests
url = "https://api.replo.app/v1/comment-threads"
payload = {
"target": {
"kind": "file",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"body": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"anchor": { "type": "none" }
}
headers = {
"Replo-Api-Version": "<replo-api-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Replo-Api-Version': '<replo-api-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
target: {kind: 'file', fileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
body: JSON.stringify('<string>'),
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
anchor: {type: 'none'}
})
};
fetch('https://api.replo.app/v1/comment-threads', 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.replo.app/v1/comment-threads",
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([
'target' => [
'kind' => 'file',
'fileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'body' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'anchor' => [
'type' => 'none'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Replo-Api-Version: <replo-api-version>"
],
]);
$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.replo.app/v1/comment-threads"
payload := strings.NewReader("{\n \"target\": {\n \"kind\": \"file\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"body\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"anchor\": {\n \"type\": \"none\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Replo-Api-Version", "<replo-api-version>")
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://api.replo.app/v1/comment-threads")
.header("Replo-Api-Version", "<replo-api-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"target\": {\n \"kind\": \"file\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"body\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"anchor\": {\n \"type\": \"none\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.replo.app/v1/comment-threads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Replo-Api-Version"] = '<replo-api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": {\n \"kind\": \"file\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"body\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"anchor\": {\n \"type\": \"none\"\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "comment_thread",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": {
"kind": "file",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"anchor": {
"type": "none"
},
"status": "open",
"resolvedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comments": [
{
"object": "comment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"source": "ui",
"body": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"editedAt": "2023-11-07T05:31:56Z",
"deleted": true
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}Comment-threads
Start a comment thread on a file, site page, order, or asset. The comment is attributed to the API key's creator.
POST
/
comment-threads
Start a comment thread on a file, site page, order, or asset. The comment is attributed to the API key's creator.
curl --request POST \
--url https://api.replo.app/v1/comment-threads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Replo-Api-Version: <replo-api-version>' \
--data '
{
"target": {
"kind": "file",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"body": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"anchor": {
"type": "none"
}
}
'import requests
url = "https://api.replo.app/v1/comment-threads"
payload = {
"target": {
"kind": "file",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"body": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"anchor": { "type": "none" }
}
headers = {
"Replo-Api-Version": "<replo-api-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Replo-Api-Version': '<replo-api-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
target: {kind: 'file', fileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
body: JSON.stringify('<string>'),
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
commentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
anchor: {type: 'none'}
})
};
fetch('https://api.replo.app/v1/comment-threads', 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.replo.app/v1/comment-threads",
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([
'target' => [
'kind' => 'file',
'fileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'body' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'commentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'anchor' => [
'type' => 'none'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Replo-Api-Version: <replo-api-version>"
],
]);
$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.replo.app/v1/comment-threads"
payload := strings.NewReader("{\n \"target\": {\n \"kind\": \"file\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"body\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"anchor\": {\n \"type\": \"none\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Replo-Api-Version", "<replo-api-version>")
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://api.replo.app/v1/comment-threads")
.header("Replo-Api-Version", "<replo-api-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"target\": {\n \"kind\": \"file\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"body\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"anchor\": {\n \"type\": \"none\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.replo.app/v1/comment-threads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Replo-Api-Version"] = '<replo-api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target\": {\n \"kind\": \"file\",\n \"fileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"body\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"commentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"anchor\": {\n \"type\": \"none\"\n }\n}"
response = http.request(request)
puts response.read_body{
"object": "comment_thread",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": {
"kind": "file",
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"anchor": {
"type": "none"
},
"status": "open",
"resolvedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"comments": [
{
"object": "comment",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author": {
"id": "<string>",
"name": "<string>",
"deleted": true
},
"source": "ui",
"body": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"editedAt": "2023-11-07T05:31:56Z",
"deleted": true
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The public API version to use for this request.
Available options:
2026-10-05 Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Markdown (GFM) parsed as MDX. To mention someone, insert <Mention data='<mentionable JSON>' />. Expressions in braces, raw HTML and any other JSX are rejected, so escape a literal { or < with a backslash. Images must be hosted on assets.replocdn.com.
Minimum string length:
1Client-generated thread id. Send the same id and commentId on a retry to get the existing thread back.
Client-generated first-comment id. Required with id.
Where on the target to start the thread; omit or pass type none for the whole target. Point anchors work only on file and asset targets; site page and order threads must use none.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
Start a comment thread on a file, site page, order, or asset. The comment is attributed to the API key's creator.
Available options:
comment_thread - Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Where on the target the thread sits; type none means the whole target.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
CommentThreadStatus
Available options:
open, resolved Show child attributes
Show child attributes