Skip to main content
POST
/
api
/
issues
/
v2
/
{issue_id}
/
comment
PostComment
curl --request POST \
  --url https://developer.synq.io/api/issues/v2/{issue_id}/comment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actor": {
    "name": "<string>",
    "email": {
      "userEmail": "jsmith@example.com"
    }
  },
  "comment": "<string>",
  "time": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://developer.synq.io/api/issues/v2/{issue_id}/comment"

payload = {
    "actor": {
        "name": "<string>",
        "email": { "userEmail": "jsmith@example.com" }
    },
    "comment": "<string>",
    "time": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actor: {name: '<string>', email: {userEmail: 'jsmith@example.com'}},
    comment: '<string>',
    time: '2023-11-07T05:31:56Z'
  })
};

fetch('https://developer.synq.io/api/issues/v2/{issue_id}/comment', 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://developer.synq.io/api/issues/v2/{issue_id}/comment",
  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([
    'actor' => [
        'name' => '<string>',
        'email' => [
                'userEmail' => 'jsmith@example.com'
        ]
    ],
    'comment' => '<string>',
    'time' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://developer.synq.io/api/issues/v2/{issue_id}/comment"

	payload := strings.NewReader("{\n  \"actor\": {\n    \"name\": \"<string>\",\n    \"email\": {\n      \"userEmail\": \"jsmith@example.com\"\n    }\n  },\n  \"comment\": \"<string>\",\n  \"time\": \"2023-11-07T05:31:56Z\"\n}")

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

	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://developer.synq.io/api/issues/v2/{issue_id}/comment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actor\": {\n    \"name\": \"<string>\",\n    \"email\": {\n      \"userEmail\": \"jsmith@example.com\"\n    }\n  },\n  \"comment\": \"<string>\",\n  \"time\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/issues/v2/{issue_id}/comment")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actor\": {\n    \"name\": \"<string>\",\n    \"email\": {\n      \"userEmail\": \"jsmith@example.com\"\n    }\n  },\n  \"comment\": \"<string>\",\n  \"time\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "commentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

issue_id
string<uuid>
required

ID of the issue to post a comment on.

Body

application/json
actor
Actor · object
required

Actor posting the comment.

comment
string
required

Comment to post.

time
string<date-time>
required

Time at which the comment was posted. Defaults to the current time. timestamp.gt = 2022-01-01T00:00:00Z timestamp.gt_lt = 2022-01-01T00:00:00Z timestamp.gt_lt_exclusive = 2022-01-01T00:00:00Z timestamp.gt_lte = 2022-01-01T00:00:00Z timestamp.gt_lte_exclusive = 2022-01-01T00:00:00Z timestamp.lt_now = true

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

Response

200 - application/json

Success

commentId
string<uuid>
required