Merge Ticketing - Comments

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.

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

userUUID

Optional

The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment.

contactUUID

Optional

The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment.

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

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsObject

Optional

remote_dataRemoteData[]

Optional

GET

/comments

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

APAC

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

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

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

Use the /linked-accounts endpoint to pull platform support information

Aha!

Asana

Azure DevOps

Basecamp

Bitbucket

ClickUp

Dixa

Freshdesk

Freshservice

Front

GitHub Issues

GitLab

Gladly

Gorgias

Height

Help Scout

Hive

Intercom

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Rally

Re:amaze

Salesforce Service Cloud

ServiceNow

Shortcut

SpotDraft

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

Ironclad

Coming soon

Targetprocess

Coming soon

Workfront

Coming soon

POST

/comments

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

APAC

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. If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment. 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.If the third party does not support specifying an author, we will append "[Posted on behalf of {name}]" to the comment. 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

Use the /linked-accounts endpoint to pull platform support information

Aha!

Asana

Azure DevOps

ClickUp

Freshdesk

Front

GitHub Issues

GitLab

Gladly

Gorgias

Help Scout

Hive

Intercom

Ironclad

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Salesforce Service Cloud

ServiceNow

Shortcut

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

Basecamp

Coming soon

Targetprocess

Coming soon

Workfront

Coming soon

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}

APAC

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

Use the /linked-accounts endpoint to pull platform support information

Aha!

Asana

Azure DevOps

Basecamp

Bitbucket

ClickUp

Dixa

Freshdesk

Freshservice

Front

GitHub Issues

GitLab

Gladly

Gorgias

Height

Help Scout

Hive

Intercom

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Rally

Re:amaze

Salesforce Service Cloud

ServiceNow

Shortcut

SpotDraft

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

Ironclad

Coming soon

Targetprocess

Coming soon

Workfront

Coming soon

GET

/comments/meta/post

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

APAC

Returns metadata for Comment POSTs.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Aha!

Asana

Azure DevOps

ClickUp

Freshdesk

Front

GitHub Issues

GitLab

Gladly

Gorgias

Help Scout

Hive

Intercom

Ironclad

Jira

Jira Data Center

Jira Service Management

Kustomer

Linear

Pivotal Tracker

Salesforce Service Cloud

ServiceNow

Shortcut

Teamwork

Trello

Wrike

Zendesk

Zoho BugTracker

Zoho Desk

Basecamp

Coming soon

Targetprocess

Coming soon

Workfront

Coming soon

Collections

Next Up

Get Started

API Reference

Previous

Next Up