accounting/accounts3

accounting/addresses2

accounting/attachments3

accounting/balancesheets2

accounting/cashflowstatements2

accounting/companyinfos2

accounting/contacts3

accounting/creditnotes2

accounting/expenses3

accounting/incomestatements2

accounting/invoices3

accounting/items2

accounting/journalentries3

accounting/payments3

accounting/phonenumbers2

accounting/purchaseorders3

accounting/taxrates2

accounting/trackingcategories2

accounting/transactions2

accounting/vendorcredits2

auth1

connections1

crm/companies3

crm/contacts3

crm/deals3

crm/engagements3

crm/notes3

crm/stages2

crm/tasks3

crm/users2

ecommerce/customers2

ecommerce/fulfillments2

ecommerce/orders3

ecommerce/products3

events1

fieldMappings6

filestorage/files3

filestorage/folders3

filestorage/groups2

filestorage/users2

linkedUsers5

marketingautomation/actions3

marketingautomation/automations3

marketingautomation/campaigns3

marketingautomation/contacts3

marketingautomation/emails2

marketingautomation/events2

marketingautomation/lists3

marketingautomation/messages2

marketingautomation/templates3

marketingautomation/users2

passthrough2

projects2

sync4

ticketing/accounts2

ticketing/attachments3

ticketing/collections2

ticketing/comments3

ticketing/contacts2

ticketing/tags2

ticketing/teams2

ticketing/tickets3

ticketing/users2

webhooks5

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"
}

Changes

Changed in 7 of the 18 revisions of this API.52227

Sep 20, 2024be3dc330edf322See the full diff
- ▲
  removed the enum value CONTACT of the request property creator_type
  request-property-enum-value-removed
- ▲
  removed the enum value USER of the request property creator_type
  request-property-enum-value-removed
- ○
  removed the CONTACT enum value from the creator_type response property for the response status 201
  response-property-enum-value-removed
- ○
  removed the USER enum value from the creator_type response property for the response status 201
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 6, 20246502b0fa098c31See the full diff
- ▲
  the attachments/items/ request property type/format changed from string/ to /
  request-property-type-changed
- ▲
  added UnifiedTicketingAttachmentOutput subschema #1 to the attachments/items/ response property oneOf list for the response status 201
  response-property-one-of-added
- ▲
  the attachments/items/ response's property type/format changed from string/ to / for status 201
  response-property-type-changed
- ○
  added UnifiedTicketingAttachmentOutput subschema #1 to the attachments/items/ request property oneOf list
  request-property-one-of-added
Aug 5, 2024ca0fa45ebd05122See the full diff
- ▲
  request property creator_type was restricted to a list of enum values
  request-property-became-enum
- ●
  added the new CONTACT enum value to the creator_type response property for the response status 201
  response-property-enum-value-added
- ●
  added the new USER enum value to the creator_type response property for the response status 201
  response-property-enum-value-added
- ○
  added the new CONTACT enum value to the request property creator_type
  request-property-enum-value-added
- ○
  added the new USER enum value to the request property creator_type
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 5, 2024ca213ae36b7f189See the full diff
- ▲
  the response property attachments became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property body became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property contact_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property created_at became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property creator_type became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property html_body became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property is_private became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property modified_at became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property remote_data became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property remote_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property ticket_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property user_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property created_at became optional for the status 201
  response-property-became-optional
- ▲
  the response property modified_at became optional for the status 201
  response-property-became-optional
- ▲
  the response property remote_data became optional for the status 201
  response-property-became-optional
- ▲
  the created_at response's property type/format changed from object/ to string/date-time for status 201
  response-property-type-changed
- ▲
  the modified_at response's property type/format changed from object/ to string/date-time for status 201
  response-property-type-changed
- ○
  the endpoint scheme security bearer was removed from the API
  api-security-removed
- ○
  the request property attachments became nullable
  request-property-became-nullable
- ○
  the request property body became nullable
  request-property-became-nullable
- ○
  the request property contact_id became nullable
  request-property-became-nullable
- ○
  the request property creator_type became nullable
  request-property-became-nullable
- ○
  the request property html_body became nullable
  request-property-became-nullable
- ○
  the request property is_private became nullable
  request-property-became-nullable
- ○
  the request property ticket_id became nullable
  request-property-became-nullable
- ○
  the request property user_id became nullable
  request-property-became-nullable
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 5, 2024167edd5346ec104See the full diff
- ▲
  the request property attachments became not nullable
  request-property-became-not-nullable
- ▲
  the request property body became not nullable
  request-property-became-not-nullable
- ▲
  the request property contact_id became not nullable
  request-property-became-not-nullable
- ▲
  the request property creator_type became not nullable
  request-property-became-not-nullable
- ▲
  the request property html_body became not nullable
  request-property-became-not-nullable
- ▲
  the request property is_private became not nullable
  request-property-became-not-nullable
- ▲
  the request property ticket_id became not nullable
  request-property-became-not-nullable
- ▲
  the request property user_id became not nullable
  request-property-became-not-nullable
- ▲
  the created_at response's property type/format changed from string/date-time to object/ for status 201
  response-property-type-changed
- ▲
  the modified_at response's property type/format changed from string/date-time to object/ for status 201
  response-property-type-changed
- ○
  the endpoint scheme security bearer was added to the API
  api-security-added
- ○
  the response property created_at became required for the status 201
  response-property-became-required
- ○
  the response property modified_at became required for the status 201
  response-property-became-required
- ○
  the response property remote_data became required for the status 201
  response-property-became-required
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 3, 20249d25bd589fe9188See the full diff
- ▲
  the response property attachments became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property body became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property contact_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property created_at became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property creator_type became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property html_body became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property is_private became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property modified_at became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property remote_data became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property remote_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property ticket_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property user_id became nullable for the status 201
  response-property-became-nullable
- ▲
  the response property created_at became optional for the status 201
  response-property-became-optional
- ▲
  the response property modified_at became optional for the status 201
  response-property-became-optional
- ▲
  the response property remote_data became optional for the status 201
  response-property-became-optional
- ▲
  the created_at response's property type/format changed from object/ to string/date-time for status 201
  response-property-type-changed
- ▲
  the modified_at response's property type/format changed from object/ to string/date-time for status 201
  response-property-type-changed
- ○
  the request property attachments became nullable
  request-property-became-nullable
- ○
  the request property body became nullable
  request-property-became-nullable
- ○
  the request property contact_id became nullable
  request-property-became-nullable
- ○
  the request property creator_type became nullable
  request-property-became-nullable
- ○
  the request property html_body became nullable
  request-property-became-nullable
- ○
  the request property is_private became nullable
  request-property-became-nullable
- ○
  the request property ticket_id became nullable
  request-property-became-nullable
- ○
  the request property user_id became nullable
  request-property-became-nullable
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 1, 2024414c3e999e0b1See the full diff
- ○
  the endpoint scheme security bearer was removed from the API
  api-security-removed

Full history