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
Enchant
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
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
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
html_body
string
One of body or html_body is required.
Supported in
Enchant
Gorgias
channel
object
The medium through which the comment was sent.
Supported in
Gorgias
id
string
The unique identifier for the channel
name
string
The name of the channel
type
string
The type of the channel
author
object
The id of the user or contact who created the comment
Required in
Enchant
Gorgias
id
string
REQUIRED ·Â
Unique identifier of the user. Required if type is "user".
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
user
contact
emails
object[]
Required if type is set to "contact"
email
string
Email address of the contact
receiver
object
The id of the user or contact who is receiving the comment
Required in
Gorgias
id
string
REQUIRED ·Â
The id of the user or contact who receiving the comment
name
string
The name of the user or contact who receiving the comment
type
string
REQUIRED ·Â
Type of the receiver
All possible enum values:
user
contact
system
subject
string
The subject of the comment
Supported in
Gorgias
is_internal
boolean
Whether the comment is internal. True for internal notes left by users.
Supported in
Enchant
contact
Required if creating an outbound reply.
Supported in
Enchant
emails
object[]
email
string
Email address of the contact
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.
Create Comments ​
Endpoint ​
Integrations supported
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
.unified
raw
normalized
unified
Excludes the
remote_data
attribute from the response.Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
Supported in
The ticket to which the comment belongs
Required in
Supported in
The unique identifier for a ticket
Required in
The unique identifier for a organization.
Required in
Request Body ​
Refer Writing data using Unified APIsSupported in
One of body or html_body is required.
Required in
Supported in
If set to true, a draft reply is created.
Supported in
Contact ID
Required in
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
Use this field to change conversation status when adding a thread. If not explicitly set, a reply thread will reactivate the conversation.
Supported in
ID of the user who is adding the thread. The resource owner is the default when not set.
Supported in
Collection of strings representing email addresses.
Supported in
Collection of strings representing email addresses.
Supported in
Optional creation date to be used when importing conversations and threads. It can only be used with imported field set to true.
Supported in
Optional list of attachments to be attached to this thread.
Supported in
The unique identifier for the attachment
The attachment's name.
The URL to download the attachment
The content type of the attachment
The user who uploaded the attachment
The user who uploaded the attachment
The user who uploaded the attachment
The type of the user who uploaded the attachment
The time when the attachment was created
The name of the file
The mime type of the file
The base64 encoded data of the file
One of body or html_body is required.
Supported in
The medium through which the comment was sent.
Supported in
The unique identifier for the channel
The name of the channel
The type of the channel
The id of the user or contact who created the comment
Required in
Unique identifier of the user. Required if type is "user".
The name of the user or contact who created the comment
Type of the author
user
contact
system
user
contact
Required if type is set to "contact"
Email address of the contact
The id of the user or contact who is receiving the comment
Required in
The id of the user or contact who receiving the comment
The name of the user or contact who receiving the comment
Type of the receiver
user
contact
system
The subject of the comment
Supported in
Whether the comment is internal. True for internal notes left by users.
Supported in
Required if creating an outbound reply.
Supported in
Email address of the contact
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 ​
The unique identifier for a comment
Supported in
The id of the user or contact who created the comment
Supported in
The id of the user or contact who created the comment
The name of the user or contact who created the comment
Type of the author
user
contact
system
The id of the user or contact who is receiving the comment
The id of the user or contact who receiving the comment
The name of the user or contact who receiving the comment
Type of the receiver
user
contact
system
The body of the comment
Supported in
The body of the comment in HTML format
Supported in
The ticket to which the comment belongs
Supported in
The unique identifier for a ticket
The attachments of the comment
Supported in
The unique identifier for the attachment
The attachment's name.
The URL to download the attachment
The content type of the attachment
The user who uploaded the attachment
The user who uploaded the attachment
The user who uploaded the attachment
The type of the user who uploaded the attachment
The time when the attachment was created
Whether the comment is internal. True for internal notes left by users.
Supported in
Whether the comment is private or not
The medium through which the comment was sent.
The unique identifier for the channel
The name of the channel
The type of the channel
The date and time when the comment was created
Supported in
The date and time when the comment was updated
Supported in
The unique identifier for the specific version of the resource.
Raw data returned from the remote API call.