Appearance

Update Comments ​

Endpoint ​

http
PATCH /unified/ticketing/comments/{id}
Integrations supported
  • Help Scout
  • Pivotal Tracker
  • Quickbase for Project Management
  • Todoist
  • Wrike
  • Zoho Projects

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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
ticket_id
string

The unique identifier for a ticket

Required in
  • Help Scout
organization
object
Required in
  • Zoho Projects
id
string

The unique identifier for a organization.

workspace
Required in
  • Zoho Projects
ticket
object

Set either ticket or collections.

Required in
  • Zoho Projects
Supported in
  • Pivotal Tracker
id
string
REQUIRED · 

The unique identifier for a ticket

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

The body of the comment

Supported in
  • Help Scout
  • Pivotal Tracker
  • Todoist
  • Wrike
  • Zoho Projects
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
  • Help Scout
  • Pivotal Tracker
  • Quickbase for Project Management
  • Todoist
  • Wrike
  • Zoho Projects
author
object

The id of the user or contact who created the comment

Supported in
  • Pivotal Tracker
  • 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

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
  • Pivotal Tracker
  • Todoist
  • Wrike
  • Zoho Projects
html_body
string

The body of the comment in HTML format

ticket
object

The ticket to which the comment belongs

Supported in
  • Pivotal Tracker
  • Todoist
  • Wrike
  • Zoho Projects
id
string
REQUIRED · 

The unique identifier for a ticket

attachments
object[]

The attachments of the comment

Supported in
  • 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.

is_private
boolean

Whether the comment is private or not

channel
object

The medium through which the comment was sent.

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
  • Pivotal Tracker
  • Todoist
  • Wrike
  • Zoho Projects
updated_at
string · date-time

The date and time when the comment was updated

Supported in
  • Pivotal Tracker
  • 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.