Create comment

Creates a comment for a specific ticket.

POST /comments

Create a comment for a ticket

cURL

curl --request POST \
  --url https://{your-subdomain}.neetodesk.com/api/v1/public/comments \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "ticket_number": "53",
  "author_email": "[e-mail]",
  "content": "We are looking into the issue.",
  "comment_type": "note"
}
'

import requests

url = "https://{your-subdomain}.neetodesk.com/api/v1/public/comments"

payload = {
    "ticket_number": "53",
    "author_email": "[e-mail]",
    "content": "We are looking into the issue.",
    "comment_type": "note"
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ticket_number: '53',
    author_email: '[e-mail]',
    content: 'We are looking into the issue.',
    comment_type: 'note'
  })
};

fetch('https://{your-subdomain}.neetodesk.com/api/v1/public/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://{your-subdomain}.neetodesk.com/api/v1/public/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([
    'ticket_number' => '53',
    'author_email' => '[e-mail]',
    'content' => 'We are looking into the issue.',
    'comment_type' => 'note'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <x-api-key>"
  ],
]);

$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://{your-subdomain}.neetodesk.com/api/v1/public/comments"

	payload := strings.NewReader("{\n  \"ticket_number\": \"53\",\n  \"author_email\": \"[e-mail]\",\n  \"content\": \"We are looking into the issue.\",\n  \"comment_type\": \"note\"\n}")

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

	req.Header.Add("X-Api-Key", "<x-api-key>")
	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://{your-subdomain}.neetodesk.com/api/v1/public/comments")
  .header("X-Api-Key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ticket_number\": \"53\",\n  \"author_email\": \"[e-mail]\",\n  \"content\": \"We are looking into the issue.\",\n  \"comment_type\": \"note\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{your-subdomain}.neetodesk.com/api/v1/public/comments")

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

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ticket_number\": \"53\",\n  \"author_email\": \"[e-mail]\",\n  \"content\": \"We are looking into the issue.\",\n  \"comment_type\": \"note\"\n}"

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

200

{
  "notice_code": "comment_created_successfully"
}

Deprecated: This is a v1 endpoint. It will continue to work, but we recommend migrating to the v2 equivalent for improved REST compliance (correct HTTP status codes, consistent response envelopes, and hyphenated URLs).

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key · string · default: your-api-key · required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json

ticket_number · string · required

Number of the ticket for the comment. Refer to Method 2 in the Getting Ticket ID section for instructions on how to find this number.

Example:

"53"

author_email · string · required

Email address of the person creating the comment.

Example:

"[e-mail]"

content · string · required

Content for the comment.

Example:

"We are looking into the issue."

comment_type · enum<string>

The type of the comment. Defaults to reply.

Available options: reply, note

Example:

"note"

Response

200 - application/json

OK - Request succeeded

notice_code · string

Example:

"comment_created_successfully"