Appearance

Create Comments ​

Endpoint ​

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

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
  • Help Scout
36
Supported in
  • Help Scout
37
Supported in
  • Help Scout
38
Supported in
  • Help Scout
39
Supported in
  • Help Scout
40
Supported in
  • Help Scout

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
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
string
The user who uploaded the attachment
uploaded_by_type
string
The type of the user who uploaded the attachment
created_at
string
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
type
string
REQUIRED · Type of the author
All possible enum values:
  • user
  • contact
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
string
The user who uploaded the attachment
uploaded_by_type
string
The type of the user who uploaded the attachment
created_at
string
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
The date and time when the comment was created
updated_at
string
The date and time when the comment was updated
remote_data
object
Raw data returned from the remote API call.