POST
/
ticketing
/
comments

Authorizations

x-api-key
string
headerrequired

Headers

x-connection-token
string
required

The connection token

Query Parameters

remote_data
boolean

Set to true to include data from the original Ticketing software.

Body

application/json
body
string | null
required

The body of the comment

html_body
string | null

The html body of the comment

is_private
boolean | null

The public status of the comment

creator_type
string | null

The creator type of the comment. Authorized values are either USER or CONTACT

ticket_id
string | null

The UUID of the ticket the comment is tied to

contact_id
string | null

The UUID of the contact which the comment belongs to (if no user_id specified)

user_id
string | null

The UUID of the user which the comment belongs to (if no contact_id specified)

attachments
array | null

The attachements UUIDs tied to the comment

Response

201 - application/json
body
string | null
required

The body of the comment

html_body
string | null

The html body of the comment

is_private
boolean | null

The public status of the comment

creator_type
string | null

The creator type of the comment. Authorized values are either USER or CONTACT

ticket_id
string | null

The UUID of the ticket the comment is tied to

contact_id
string | null

The UUID of the contact which the comment belongs to (if no user_id specified)

user_id
string | null

The UUID of the user which the comment belongs to (if no contact_id specified)

attachments
array | null

The attachements UUIDs tied to the comment

id
string | null

The UUID of the comment

remote_id
string | null

The id of the comment in the context of the 3rd Party

remote_data
object | null

The remote data of the comment in the context of the 3rd Party

created_at
string | null

The created date of the object

modified_at
string | null

The modified date of the object

Was this page helpful?

Retrieve CollectionsList Comments