Comments
The Comment object is used to represent a comment on a ticket.
Properties
idUUID
Required
remote_idString
Optional
The third-party API ID of the matching object.
userUUID
Optional
The author of the Comment, if the author is a User.
contactUUID
Optional
The author of the Comment, if the author is a Contact.
bodyString
Optional
The comment's text body.
html_bodyString
Optional
The comment's text body formatted as html.
ticketUUID
Optional
The ticket associated with the comment.
is_privateBoolean
Optional
Whether or not the comment is internal.
remote_created_atDateTime (ISO 8601)
Optional
When the third party's comment was created.
remote_was_deletedBoolean
Required
created_atDateTime (ISO 8601)
Required
modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
GET
/comments

https://api.merge.dev/api/ticketing/v1/comments

US
EU

Returns a list of Comment objects.


Query & Path Parameters
created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page.
remote_created_afterDateTime (ISO 8601)
Optional
If provided, will only return Comments created in the third party platform after this datetime.
remote_idString
Optional
The API provider's ID for the given object.
ticket_idString
Optional
If provided, will only return comments for this ticket.
Field support by integration
See all supported fields
Aha!
Aha!
Asana
Asana
Azure DevOps
Azure DevOps
Basecamp
Basecamp
Bitbucket
Bitbucket
ClickUp
ClickUp
Dixa
Dixa
Freshdesk
Freshdesk
Freshservice
Freshservice
Front
Front
GitHub Issues
GitHub Issues
GitLab
GitLab
Gladly
Gladly
Gorgias
Gorgias
Height
Height
Help Scout
Help Scout
Hive
Hive
Intercom
Intercom
Jira
Jira
Jira Service Management
Jira Service Management
Kustomer
Kustomer
Linear
Linear
Pivotal Tracker
Pivotal Tracker
Rally
Rally
Re:amaze
Re:amaze
Salesforce Service Cloud
Salesforce Service Cloud
ServiceNow
ServiceNow
Shortcut
Shortcut
SpotDraft
SpotDraft
Teamwork
Teamwork
Trello
Trello
Wrike
Wrike
Zendesk
Zendesk
Zoho BugTracker
Zoho BugTracker
Zoho Desk
Zoho Desk
Ironclad
Ironclad
Coming soon
Targetprocess
Targetprocess
Coming soon
Workfront
Workfront
Coming soon
Use the /linked-accounts endpoint to pull platform support information.
Not seeing a platform that you're looking for? Submit a request for it here.
POST
/comments

https://api.merge.dev/api/ticketing/v1/comments

US
EU

Creates a Comment object with the given values.


Query & Path Parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.
userUUID
The author of the Comment, if the author is a User. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.
contactUUID
The author of the Comment, if the author is a Contact. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.
bodyString
The comment's text body.
html_bodyString
The comment's text body formatted as html.
ticketUUID
The ticket associated with the comment. Must pass in a valid Merge ID, which can be obtained from the id field in the Ticket object.
is_privateBoolean
Whether or not the comment is internal.
integration_paramsObject
linked_account_paramsObject
Field support by integration
See all supported fields
Aha!
Aha!
Asana
Asana
Azure DevOps
Azure DevOps
ClickUp
ClickUp
Freshdesk
Freshdesk
Front
Front
GitHub Issues
GitHub Issues
GitLab
GitLab
Gladly
Gladly
Gorgias
Gorgias
Help Scout
Help Scout
Hive
Hive
Intercom
Intercom
Ironclad
Ironclad
Jira
Jira
Jira Service Management
Jira Service Management
Kustomer
Kustomer
Linear
Linear
Pivotal Tracker
Pivotal Tracker
Salesforce Service Cloud
Salesforce Service Cloud
ServiceNow
ServiceNow
Shortcut
Shortcut
Teamwork
Teamwork
Trello
Trello
Wrike
Wrike
Zendesk
Zendesk
Zoho BugTracker
Zoho BugTracker
Zoho Desk
Zoho Desk
Basecamp
Basecamp
Coming soon
Targetprocess
Targetprocess
Coming soon
Workfront
Workfront
Coming soon
Use the /linked-accounts endpoint to pull platform support information.
Not seeing a platform that you're looking for? Submit a request for it here.
To include the correct model fields when making POST requests, use the GET /comments/meta/post endpoint. Learn more in our /meta guide.
GET
/comments/{id}

https://api.merge.dev/api/ticketing/v1/comments/{id}

US
EU

Returns a Comment object with the given id.


Query & Path Parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Aha!
Aha!
Asana
Asana
Azure DevOps
Azure DevOps
Basecamp
Basecamp
Bitbucket
Bitbucket
ClickUp
ClickUp
Dixa
Dixa
Freshdesk
Freshdesk
Freshservice
Freshservice
Front
Front
GitHub Issues
GitHub Issues
GitLab
GitLab
Gladly
Gladly
Gorgias
Gorgias
Height
Height
Help Scout
Help Scout
Hive
Hive
Intercom
Intercom
Jira
Jira
Jira Service Management
Jira Service Management
Kustomer
Kustomer
Linear
Linear
Pivotal Tracker
Pivotal Tracker
Rally
Rally
Re:amaze
Re:amaze
Salesforce Service Cloud
Salesforce Service Cloud
ServiceNow
ServiceNow
Shortcut
Shortcut
SpotDraft
SpotDraft
Teamwork
Teamwork
Trello
Trello
Wrike
Wrike
Zendesk
Zendesk
Zoho BugTracker
Zoho BugTracker
Zoho Desk
Zoho Desk
Ironclad
Ironclad
Coming soon
Targetprocess
Targetprocess
Coming soon
Workfront
Workfront
Coming soon
Use the /linked-accounts endpoint to pull platform support information.
Not seeing a platform that you're looking for? Submit a request for it here.
GET
/comments/meta/post

https://api.merge.dev/api/ticketing/v1/comments/meta/post

US
EU

Returns metadata for Comment POSTs.


Field support by integration
See all supported fields
Aha!
Aha!
Asana
Asana
Azure DevOps
Azure DevOps
Basecamp
Basecamp
Bitbucket
Bitbucket
ClickUp
ClickUp
Dixa
Dixa
Freshdesk
Freshdesk