v49

latestOpenAPI 3.0.0raw.githubusercontent.com2024-12-22168107389.8 KB

ticketing/comments

Create Comments

Create Comments in any supported Ticketing software

post/ticketing/comments

Query parameters

remote_databoolean

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

Headers

x-connection-tokenstring required

The connection token

Request body

bodystring nullable required

The body of the comment

html_bodystring nullable

The html body of the comment

is_privateboolean nullable

The public status of the comment

creator_typestring nullable

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

ticket_idstring nullable

The UUID of the ticket the comment is tied to

contact_idstring nullable

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

user_idstring nullable

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

Example request

{
  "body": "Assigned to Eric !",
  "html_body": "<p>Assigned to Eric !</p>",
  "creator_type": "USER",
  "ticket_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "attachments": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ]
}

Response

bodystring nullable required

The body of the comment

html_bodystring nullable

The html body of the comment

is_privateboolean nullable

The public status of the comment

creator_typestring nullable

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

ticket_idstring nullable

The UUID of the ticket the comment is tied to

contact_idstring nullable

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

user_idstring nullable

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

idstring nullable

The UUID of the comment

remote_idstring nullable

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

remote_dataobject nullable

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

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "body": "Assigned to Eric !",
  "html_body": "<p>Assigned to Eric !</p>",
  "creator_type": "USER",
  "ticket_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "contact_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "user_id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "attachments": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}