Appearance

Create Comments ​

Endpoint ​

http
POST /unified/ticketing/comments
Integrations supported
  • Gorgias
  • Help Scout

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
1
Supported in
  • Gorgias
  • Help Scout
2
Supported in
  • Gorgias
  • Help Scout
3
Supported in
  • Gorgias
  • Help Scout
4
Supported in
  • Gorgias
  • Help Scout
5
Supported in
  • Gorgias
  • Help Scout
6
Supported in
  • Gorgias
  • Help Scout
7
Supported in
  • Gorgias
  • Help Scout
8
Supported in
  • Gorgias
  • Help Scout
9
Supported in
  • Gorgias
  • Help Scout
10
Supported in
  • Gorgias
  • Help Scout
11
Supported in
  • Gorgias
  • Help Scout
12
Supported in
  • Gorgias
  • Help Scout
13
Supported in
  • Gorgias
  • Help Scout
14
Supported in
  • Gorgias
  • Help Scout
15
Supported in
  • Gorgias
  • Help Scout
16
Supported in
  • Gorgias
  • Help Scout
17
Supported in
  • Gorgias
  • Help Scout
18
Supported in
  • Gorgias
  • Help Scout
19
Supported in
  • Gorgias
  • Help Scout
20
Supported in
  • Gorgias
  • Help Scout
21
Supported in
  • Gorgias
  • Help Scout
22
Supported in
  • Gorgias
  • Help Scout
23
Supported in
  • Gorgias
  • Help Scout
24
Supported in
  • Gorgias
  • Help Scout
25
Supported in
  • Gorgias
  • Help Scout
26
Supported in
  • Gorgias
  • Help Scout
27
Supported in
  • Gorgias
  • Help Scout
28
Supported in
  • Gorgias
  • Help Scout
29
Supported in
  • Gorgias
  • Help Scout
30
Supported in
  • Gorgias
  • Help Scout
31
Supported in
  • Gorgias
  • Help Scout
32
Supported in
  • Gorgias
  • Help Scout
33
Supported in
  • Gorgias
  • Help Scout
34
Supported in
  • Gorgias
  • Help Scout
35
Supported in
  • Gorgias
  • Help Scout
36
Supported in
  • Gorgias
  • Help Scout
37
Supported in
  • Gorgias
  • Help Scout
38
Supported in
  • Gorgias
  • Help Scout
39
Supported in
  • Gorgias
  • Help Scout
40
Supported in
  • Gorgias
  • Help Scout
41
Supported in
  • Gorgias
42
Supported in
  • Gorgias
43
Supported in
  • Gorgias
44
Supported in
  • Gorgias
45
Supported in
  • Gorgias
46
Supported in
  • Gorgias
47
Supported in
  • Gorgias
48
Supported in
  • Gorgias
49
Supported in
  • Gorgias
50
Supported in
  • Gorgias
51
Supported in
  • Gorgias
52
Supported in
  • Gorgias
53
Supported in
  • Gorgias
54
Supported in
  • Gorgias
55
Supported in
  • Gorgias
56
Supported in
  • Gorgias
57
Supported in
  • Gorgias
58
Supported in
  • Gorgias
59
Supported in
  • Gorgias
60
Supported in
  • Gorgias
61
Supported in
  • Gorgias
62
Supported in
  • Gorgias
63
Supported in
  • Gorgias
64
Supported in
  • Gorgias
65
Supported in
  • Gorgias
66
Supported in
  • Gorgias
67
Supported in
  • Gorgias
68
Supported in
  • Gorgias
69
Supported in
  • Gorgias
70
Supported in
  • Gorgias
71
Supported in
  • Gorgias
72
Supported in
  • Gorgias
73
Supported in
  • Gorgias
74
Supported in
  • Gorgias
75
Supported in
  • Gorgias
76
Supported in
  • Gorgias
77
Supported in
  • Gorgias
78
Supported in
  • Gorgias
79
Supported in
  • Gorgias
80
Supported in
  • Gorgias
81
Supported in
  • Gorgias
82
Supported in
  • Gorgias
83
Supported in
  • Gorgias
84
Supported in
  • Gorgias
85
Supported in
  • Gorgias
86
Supported in
  • Gorgias
87
Supported in
  • Gorgias
88
Supported in
  • Gorgias
89
Supported in
  • Gorgias
90
Supported in
  • Gorgias
91
Supported in
  • Gorgias
92
Supported in
  • Gorgias
93
Supported in
  • Gorgias
94
Supported in
  • Gorgias
95
Supported in
  • Gorgias
96
Supported in
  • Gorgias
97
Supported in
  • Gorgias
98
Supported in
  • Gorgias
99
Supported in
  • Gorgias
100
Supported in
  • Gorgias
101
Supported in
  • Gorgias
102
Supported in
  • Gorgias
103
Supported in
  • Gorgias
104
Supported in
  • Gorgias
105
Supported in
  • Gorgias
106
Supported in
  • Gorgias
107
Supported in
  • Gorgias
108
Supported in
  • Gorgias
109
Supported in
  • Gorgias
110
Supported in
  • Gorgias
111
Supported in
  • Gorgias
112
Supported in
  • Gorgias
113
Supported in
  • Gorgias
114
Supported in
  • Gorgias
115
Supported in
  • Gorgias
116
Supported in
  • Gorgias
117
Supported in
  • Gorgias
118
Supported in
  • Gorgias
119
Supported in
  • Gorgias
120
Supported in
  • Gorgias
121
Supported in
  • Gorgias
122
Supported in
  • Gorgias
123
Supported in
  • Gorgias
124
Supported in
  • Gorgias
125
Supported in
  • Gorgias
126
Supported in
  • Gorgias
127
Supported in
  • Gorgias
128
Supported in
  • Gorgias
129
Supported in
  • Gorgias
130
Supported in
  • Gorgias
131
Supported in
  • Gorgias
132
Supported in
  • Gorgias
133
Supported in
  • Gorgias
134
Supported in
  • Gorgias
135
Supported in
  • Gorgias
136
Supported in
  • Gorgias
137
Supported in
  • Gorgias
138
Supported in
  • Gorgias
139
Supported in
  • Gorgias
140
Supported in
  • Gorgias
141
Supported in
  • Gorgias
142
Supported in
  • Gorgias
143
Supported in
  • Gorgias
144
Supported in
  • Gorgias
145
Supported in
  • Gorgias
146
Supported in
  • Gorgias
147
Supported in
  • Gorgias
148
Supported in
  • Gorgias
149
Supported in
  • Gorgias
150
Supported in
  • Gorgias
151
Supported in
  • Gorgias
152
Supported in
  • Gorgias
153
Supported in
  • Gorgias
154
Supported in
  • Gorgias
155
Supported in
  • Gorgias
156
Supported in
  • Gorgias
157
Supported in
  • Gorgias
158
Supported in
  • Gorgias
159
Supported in
  • Gorgias
160
Supported in
  • Gorgias
161
Supported in
  • Gorgias
162
Supported in
  • Gorgias
163
Supported in
  • Gorgias
164
Supported in
  • Gorgias
165
Supported in
  • Gorgias
166
Supported in
  • Gorgias
167
Supported in
  • Gorgias
168
Supported in
  • Gorgias
169
Supported in
  • Gorgias
170
Supported in
  • Gorgias
171
Supported in
  • Gorgias
172
Supported in
  • Gorgias
173
Supported in
  • Gorgias
174
Supported in
  • Gorgias

Request Body ​

Refer Writing data using Unified APIs

body
string

The full text version of the body of the message, if any

Required in
  • Help Scout
Supported in
  • Gorgias
draft
boolean

If set to true, a draft reply is created.

Supported in
  • Help Scout
contact_id
number

Contact ID

Required in
  • Help Scout
imported
boolean

The imported field enables thread to be created for historical purposes (i.e. if moving from a different platform, you can import your history). When imported is set to true, no outgoing emails or notifications will be generated.

Supported in
  • Help Scout
status
string

Use this field to change conversation status when adding a thread. If not explicitly set, a reply thread will reactivate the conversation.

Supported in
  • Help Scout
user_id
number

ID of the user who is adding the thread. The resource owner is the default when not set.

Supported in
  • Help Scout
cc
string[]

Collection of strings representing email addresses.

Supported in
  • Help Scout
bcc
string[]

Collection of strings representing email addresses.

Supported in
  • Help Scout
created_at
string · date-time

Optional creation date to be used when importing conversations and threads. It can only be used with imported field set to true.

Supported in
  • Gorgias
  • Help Scout
attachments
object[]

Optional list of attachments to be attached to this thread.

Supported in
  • Gorgias
  • Help Scout
id
string

The unique identifier for the attachment

file_name
string

The attachment's name.

file_url
string

The URL to download the attachment

content_type
string
REQUIRED · 

The MIME type of the file

uploaded_by
object

The user who uploaded the attachment

id
string

The user who uploaded the attachment

name
string

The user who uploaded the attachment

uploaded_by_type
string

The type of the user who uploaded the attachment

created_at
string · date-time

The time when the attachment was created

fileName
string
REQUIRED · 

The name of the file

mimeType
string
REQUIRED · 

The mime type of the file

data
string
REQUIRED · 

The base64 encoded data of the file

url
string
REQUIRED · 

The URL to access to the attached file

name
string
REQUIRED · 

The name of the file

size
number
REQUIRED · 

The size of the file, in bytes

public
boolean

Whether or not the attachment can be accessed

extra
string

Extra information for custom content type attachment

html_body
string

The full HTML version of the body of the message, if any

Supported in
  • Gorgias
channel
string

The channel used to send the message

Required in
  • Gorgias
external_id
string
Supported in
  • Gorgias
failed_datetime
string
Supported in
  • Gorgias
from_agent
boolean
Required in
  • Gorgias
message_id
number
Supported in
  • Gorgias
receiver
object
Supported in
  • Gorgias
id
number
email
string
sender
object
Required in
  • Gorgias
id
number
email
string
sent_datetime
string
Supported in
  • Gorgias
source
object[]
Supported in
  • Gorgias
type
string
to
object[]
name
string
address
string
cc
object[]
name
string
address
string
bcc
object[]
name
string
address
string
from
object
name
string
address
string
subject
string
Supported in
  • Gorgias
via
string
Supported in
  • Gorgias
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string
REQUIRED · 

The unique identifier for a comment

author
object

The id of the user or contact who created the comment

id
string
REQUIRED · 

The id of the user or contact who created the comment

name
string

The name of the user or contact who created the comment

type
string
REQUIRED · 

Type of the author

All possible enum values:
  • user
  • contact
  • system
body
string

The body of the comment

html_body
string

The body of the comment in HTML format

ticket
object

The ticket to which the comment belongs

id
string
REQUIRED · 

The unique identifier for a ticket

attachments
object[]

The attachments of the comment

id
string

The unique identifier for the attachment

file_name
string

The attachment's name.

file_url
string

The URL to download the attachment

content_type
string

The content type of the attachment

uploaded_by
object

The user who uploaded the attachment

id
string

The user who uploaded the attachment

name
string

The user who uploaded the attachment

uploaded_by_type
string

The type of the user who uploaded the attachment

created_at
string · date-time

The time when the attachment was created

is_internal
boolean

Whether the comment is internal. True for internal notes left by users.

is_private
boolean

Whether the comment is private or not

created_at
string · date-time

The date and time when the comment was created

updated_at
string · date-time

The date and time when the comment was updated

remote_data
object

Raw data returned from the remote API call.