Appearance

Create Comments ​

Endpoint ​

http
POST /unified/ticketing/comments
Integrations supported
  • Dixa
  • Enchant
  • Gorgias
  • Help Scout
  • Hive
  • Jira
  • Pivotal Tracker
  • Quickbase for Project Management
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Todoist
  • Wrike
  • Zoho Projects

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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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
ticket_id
string

The unique identifier for a ticket

Required in
  • Help Scout
ticket
object

Set either ticket or collections.

Required in
  • Dixa
  • Hive
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Wrike
  • Zoho Projects
Supported in
  • Enchant
  • Pivotal Tracker
  • Re:amaze
id
string
REQUIRED · 

The unique identifier for a ticket

organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

workspace
Required in
  • Zoho Projects
collections

Collection with type epic is required.

Supported in
  • Pivotal Tracker
id
string

The unique identifier for a collection.

Request Body ​

Refer Writing data using Unified APIs

custom_fields
Supported in
  • Quickbase for Project Management
body
string

One of body or html_body is required.

Required in
  • Dixa
  • Help Scout
  • Jira
  • Pivotal Tracker
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Todoist
  • Wrike
  • Zoho Projects
Supported in
  • Enchant
  • Gorgias
draft
boolean

If set to true, a draft reply is created.

Supported in
  • 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
REQUIRED · 

The name of the file

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

data
string
REQUIRED · 

The base64 encoded data of the file

contact_id
string

The id of the contact who created the comment.

Required in
  • Help Scout
user_id
string

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

Supported 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
cc
string[]

Collection of strings representing email addresses.

Supported in
  • Help Scout
bcc
string[]

Collection of strings representing email addresses.

Supported in
  • Help Scout
html_body
string

One of body or html_body is required.

Required in
  • Hive
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

created_at
string · date-time

The date and time when the comment was created

Supported in
  • Gorgias
author
object

The id of the user or contact who created the comment

Required in
  • Enchant
  • Gorgias
Supported in
  • Dixa
  • Pivotal Tracker
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
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
ticket
object

Either ticket or collections is required.

References: Tickets → id
Required in
  • Jira
Supported in
  • Todoist
id
string
REQUIRED · 

The unique identifier for a ticket

is_internal
boolean

Set this value as true if the comment is internal note.

All possible enum values:
  • true
Enum support by integration
  • Re:amaze
    • true
Supported in
  • Enchant
  • Re:amaze
contact

Required if creating an outbound reply.

Supported in
  • Enchant
emails
object[]
email
string

Email address of the contact

collections

Either ticket or collections is required.

Supported in
  • Todoist
is_private
boolean

Whether the comment is private or not

Supported in
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
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

Supported in
  • Dixa
  • Enchant
  • Hive
  • Jira
  • Pivotal Tracker
  • Quickbase for Project Management
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Todoist
  • Wrike
  • Zoho Projects
author
object

The id of the user or contact who created the comment

Supported in
  • Dixa
  • Enchant
  • Hive
  • Jira
  • Pivotal Tracker
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Wrike
  • Zoho Projects
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
receiver
object

The id of the user or contact who is receiving the comment

Supported in
  • Re:amaze
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
body
string

The body of the comment

Supported in
  • Dixa
  • Enchant
  • Jira
  • Pivotal Tracker
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Todoist
  • Wrike
  • Zoho Projects
html_body
string

The body of the comment in HTML format

Supported in
  • Dixa
  • Enchant
  • Hive
  • Jira
  • Re:amaze
ticket
object

The ticket to which the comment belongs

References: Tickets → id
Supported in
  • Dixa
  • Enchant
  • Hive
  • Jira
  • Pivotal Tracker
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Todoist
  • Wrike
  • Zoho Projects
id
string
REQUIRED · 

The unique identifier for a ticket

attachments
object[]

The attachments of the comment

Supported in
  • Dixa
  • Enchant
  • Hive
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Todoist
  • Wrike
  • Zoho Projects
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.

Supported in
  • Dixa
  • Enchant
  • Re:amaze
is_private
boolean

Whether the comment is private or not

Supported in
  • Jira
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
channel
object

The medium through which the comment was sent.

Supported in
  • Dixa
id
string

The unique identifier for the channel

name
string

The name of the channel

type
string

The type of the channel

created_at
string · date-time

The date and time when the comment was created

Supported in
  • Dixa
  • Enchant
  • Hive
  • Jira
  • Pivotal Tracker
  • Re:amaze
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Todoist
  • Wrike
  • Zoho Projects
updated_at
string · date-time

The date and time when the comment was updated

Supported in
  • Jira
  • Pivotal Tracker
  • SolarWinds Service Desk
  • Wrike
  • Zoho Projects
etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.