Adds a comment to a ticket - Gorelo Documentation

POST

tickets

{ticketId}

comments

Adds a comment to a ticket

curl --request POST \
  --url https://api.usw.gorelo.io/v1/tickets/{ticketId}/comments \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "ConversationTypeId": 123,
  "Body": "<string>",
  "ConversationId": "<string>",
  "CreatedByName": "<string>",
  "CreatedOn": "2023-11-07T05:31:56Z",
  "Attachments": [
    {
      "Name": "<string>",
      "Url": "<string>"
    }
  ]
}
'

import requests

url = "https://api.usw.gorelo.io/v1/tickets/{ticketId}/comments"

payload = {
    "ConversationTypeId": 123,
    "Body": "<string>",
    "ConversationId": "<string>",
    "CreatedByName": "<string>",
    "CreatedOn": "2023-11-07T05:31:56Z",
    "Attachments": [
        {
            "Name": "<string>",
            "Url": "<string>"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    ConversationTypeId: 123,
    Body: '<string>',
    ConversationId: '<string>',
    CreatedByName: '<string>',
    CreatedOn: '2023-11-07T05:31:56Z',
    Attachments: [{Name: '<string>', Url: '<string>'}]
  })
};

fetch('https://api.usw.gorelo.io/v1/tickets/{ticketId}/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://api.usw.gorelo.io/v1/tickets/{ticketId}/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([
    'ConversationTypeId' => 123,
    'Body' => '<string>',
    'ConversationId' => '<string>',
    'CreatedByName' => '<string>',
    'CreatedOn' => '2023-11-07T05:31:56Z',
    'Attachments' => [
        [
                'Name' => '<string>',
                'Url' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <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://api.usw.gorelo.io/v1/tickets/{ticketId}/comments"

	payload := strings.NewReader("{\n  \"ConversationTypeId\": 123,\n  \"Body\": \"<string>\",\n  \"ConversationId\": \"<string>\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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.usw.gorelo.io/v1/tickets/{ticketId}/comments")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"ConversationTypeId\": 123,\n  \"Body\": \"<string>\",\n  \"ConversationId\": \"<string>\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/tickets/{ticketId}/comments")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"ConversationTypeId\": 123,\n  \"Body\": \"<string>\",\n  \"ConversationId\": \"<string>\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ]\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Path Parameters

ticketId

string<uuid>

required

Ticket identifier.

Body

Comment details.

ConversationTypeId

integer<int64>

required

1 Public, 2 Private, 3 Side Conversation, 4 Approval.

Body

string

required

Comment body as HTML. Mentions go inside the HTML. A literal < or > in the text must be sent as < / >.

Minimum string length: 1

ConversationId

string | null

Identifier of the conversation to post into. Required for Side Conversation and Approval, and rejected for Public and Private, which are the ticket's main thread.

CreatedByName

string | null

Display name to show the comment as. The comment is still recorded as API-authored — a name cannot be used to post as a specific real user. Omitted or blank, it is recorded as API.

CreatedOn

string<date-time> | null

Backdate the comment's timestamp — for importing ticket history from another system. Must not be in the future or earlier than the ticket's own CreatedOn. Omit to use the current time.

When supplied, the ticket's UpdatedOn becomes the later of its current value and this timestamp, so importing older history does not push the ticket to the top of an updatedOn-sorted list.

Send only when importing history. A record with this field set sends no emails or notifications.

Attachments

object[]

Files to attach, as returned by the attachment upload endpoint.

Show child attributes

Response

StatusCode

enum<integer>

Available options:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

Show child attributes

DataContext

object | null

Example:

null

Notifications

object[]

Show child attributes

⌘I

Adds a comment to a ticket

curl --request POST \
  --url https://api.usw.gorelo.io/v1/tickets/{ticketId}/comments \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "ConversationTypeId": 123,
  "Body": "<string>",
  "ConversationId": "<string>",
  "CreatedByName": "<string>",
  "CreatedOn": "2023-11-07T05:31:56Z",
  "Attachments": [
    {
      "Name": "<string>",
      "Url": "<string>"
    }
  ]
}
'

import requests

url = "https://api.usw.gorelo.io/v1/tickets/{ticketId}/comments"

payload = {
    "ConversationTypeId": 123,
    "Body": "<string>",
    "ConversationId": "<string>",
    "CreatedByName": "<string>",
    "CreatedOn": "2023-11-07T05:31:56Z",
    "Attachments": [
        {
            "Name": "<string>",
            "Url": "<string>"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    ConversationTypeId: 123,
    Body: '<string>',
    ConversationId: '<string>',
    CreatedByName: '<string>',
    CreatedOn: '2023-11-07T05:31:56Z',
    Attachments: [{Name: '<string>', Url: '<string>'}]
  })
};

fetch('https://api.usw.gorelo.io/v1/tickets/{ticketId}/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://api.usw.gorelo.io/v1/tickets/{ticketId}/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([
    'ConversationTypeId' => 123,
    'Body' => '<string>',
    'ConversationId' => '<string>',
    'CreatedByName' => '<string>',
    'CreatedOn' => '2023-11-07T05:31:56Z',
    'Attachments' => [
        [
                'Name' => '<string>',
                'Url' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <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://api.usw.gorelo.io/v1/tickets/{ticketId}/comments"

	payload := strings.NewReader("{\n  \"ConversationTypeId\": 123,\n  \"Body\": \"<string>\",\n  \"ConversationId\": \"<string>\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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.usw.gorelo.io/v1/tickets/{ticketId}/comments")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"ConversationTypeId\": 123,\n  \"Body\": \"<string>\",\n  \"ConversationId\": \"<string>\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/tickets/{ticketId}/comments")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"ConversationTypeId\": 123,\n  \"Body\": \"<string>\",\n  \"ConversationId\": \"<string>\",\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ]\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}