Skip to content

Comments Object



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.