Skip to content

Relationships

Schema relationships
graph LR
    Comments -->|"ticket"| Tickets

Properties

idstring
required·

The unique identifier for a comment

attachmentsobject[]

The attachments of the comment

content_typestring

The content type of the attachment

created_atstring · date-time

The time when the attachment was created

file_namestring

The attachment's name.

file_urlstring

The URL to download the attachment

idstring

The unique identifier for the attachment

uploaded_byobject

The user who uploaded the attachment

2 properties
idstring

The user who uploaded the attachment

namestring

The user who uploaded the attachment

uploaded_by_typestring

The type of the user who uploaded the attachment

authorobject

The id of the user or contact who created the comment

idstring
required·

The id of the user or contact who created the comment

typestring
required·

Type of the author

Possible values:
usercontactsystem
namestring

The name of the user or contact who created the comment

usernamestring

The username of the user or contact who created the comment

bodystring

The body of the comment

channelobject

The medium through which the comment was sent.

idstring

The unique identifier for the channel

namestring

The name of the channel

typestring

The type of the channel

created_atstring · date-time

The date and time when the comment was created

etagstring

The unique identifier for the specific version of the resource.

html_bodystring

The body of the comment in HTML format

is_internalboolean

Whether the comment is internal. True for internal notes left by users.

is_privateboolean

Whether the comment is private or not

receiverobject

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

idstring
required·

The id of the user or contact who receiving the comment

typestring
required·

Type of the receiver

Possible values:
usercontactsystem
namestring

The name of the user or contact who receiving the comment

remote_dataRecord<string, any>

Raw data returned from the remote API call.

ticketobject

The ticket to which the comment belongs

References: Tickets → id
idstring
required·

The unique identifier for a ticket

updated_atstring · date-time

The date and time when the comment was updated