Comments

The Comment object is used to represent a comment on a ticket.

The Comment object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

userString
Optional

contactString
Optional

bodyString
Optional
The comment's text body.

html_bodyString
Optional
The comment's text body formatted as html.

ticketString
Optional

is_privateBoolean
Optional
Whether or not the comment is internal.

remote_created_atString
Optional
When the third party's comment was created.

remote_was_deletedBoolean
Required

The Comment object
JSON
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "19202938",
"user": "17a54124-287f-494d-965e-3c5b330c9a68",
"contact": "dde3fb16-b8eb-483d-81c4-b78100816f15",
"body": "When will these integrations be done? You all should use Merge.",
"html_body": "When will these integrations be done? You all should use <b>Merge<b>.",
"ticket": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
"is_private": true,
"remote_created_at": "1990-11-10T00:00:00Z",
"remote_was_deleted": true
}

GET

/comments

Returns a list of Comment objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
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_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

ticket_idString
Optional
If provided, will only return comments for this ticket.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "19202938",
"user": "17a54124-287f-494d-965e-3c5b330c9a68",
"contact": "dde3fb16-b8eb-483d-81c4-b78100816f15",
"body": "When will these integrations be done? You all should use Merge.",
"html_body": "When will these integrations be done? You all should use <b>Merge<b>.",
"ticket": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
"is_private": true,
"remote_created_at": "1990-11-10T00:00:00Z",
"remote_was_deleted": true
}
]
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

remote_created_atString

remote_idString

ticketString

userString

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString
Trello

Trello

Coming Soon
Gitlab

Gitlab

Coming Soon
Zoho Desk

Zoho Desk

Coming Soon
Basecamp

Basecamp

Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST

/comments

Creates a Comment object with the given values.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

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


remote_idString
Optional
The third-party API ID of the matching object.

userString
Optional
Must pass in a valid Merge ID, which can be obtained from the id field in the User table.

contactString
Optional
Must pass in a valid Merge ID, which can be obtained from the id field in the Contact table.

bodyString
Optional
The comment's text body.

html_bodyString
Optional
The comment's text body formatted as html.

ticketString
Optional
Must pass in a valid Merge ID, which can be obtained from the id field in the Ticket table.

is_privateBoolean
Optional
Whether or not the comment is internal.

remote_created_atString
Optional
When the third party's comment was created.

Response
JSON
{
"model": {
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "19202938",
"user": "17a54124-287f-494d-965e-3c5b330c9a68",
"contact": "dde3fb16-b8eb-483d-81c4-b78100816f15",
"body": "When will these integrations be done? You all should use Merge.",
"html_body": "When will these integrations be done? You all should use <b>Merge<b>.",
"ticket": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
"is_private": true,
"remote_created_at": "1990-11-10T00:00:00Z",
"remote_was_deleted": true
},
"warnings": [
{
"source": {
"pointer": "/age"
},
"title": "Unrecognized Field",
"detail": "An unrecognized field, age, was passed in with request data.",
"problem_type": "UNRECOGNIZED_FIELD"
}
],
"errors": [
{
"source": {
"pointer": "/model/custom_fields"
},
"title": "Missing Required Field",
"detail": "custom_fields is a required field on model.",
"problem_type": "MISSING_REQUIRED_FIELD"
}
],
"logs": [
{
"log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
"dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
"log_summary": {
"url": "https://harvest.greenhouse.io/v1/candidates/",
"method": "POST",
"status_code": 200
}
}
]
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Required

html_bodyString
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Optional

userString
Optional

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Optional

contactString
Optional

html_bodyString
Required

is_privateBoolean
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Optional

html_bodyString
Optional

is_privateBoolean
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Required

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Optional

html_bodyString
Required

is_privateBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


contactString
Optional

html_bodyString
Required

is_privateBoolean
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


html_bodyString
Optional

is_privateBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Required

is_privateBoolean
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Required

is_privateBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


html_bodyString
Required

is_privateBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Required

is_privateBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


bodyString
Optional

contactString
Optional

html_bodyString
Optional

is_privateBoolean
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

userString
Optional
Trello

Trello

Coming Soon
Gitlab

Gitlab

Coming Soon
Zoho Desk

Zoho Desk

Coming Soon
Basecamp

Basecamp

Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/comments/{id}

Returns a Comment object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "19202938",
"user": "17a54124-287f-494d-965e-3c5b330c9a68",
"contact": "dde3fb16-b8eb-483d-81c4-b78100816f15",
"body": "When will these integrations be done? You all should use Merge.",
"html_body": "When will these integrations be done? You all should use <b>Merge<b>.",
"ticket": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
"is_private": true,
"remote_created_at": "1990-11-10T00:00:00Z",
"remote_was_deleted": true
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

remote_created_atString

remote_idString

ticketString

userString

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString
Trello

Trello

Coming Soon
Gitlab

Gitlab

Coming Soon
Zoho Desk

Zoho Desk

Coming Soon
Basecamp

Basecamp

Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/comments/meta/post

Returns metadata for Comment POSTs.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
"request_schema": {},
"status": {
"linked_account_status": "string",
"can_make_request": true
},
"has_conditional_params": true,
"has_required_linked_account_params": true
}
Field support by platform

Asana

Asana

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

GitHub Issues

GitHub Issues

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

remote_created_atString

remote_idString

ticketString

userString

Intercom

Intercom

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

contactString

html_bodyString

is_privateBoolean

remote_created_atString

remote_idString

ticketString

userString
Trello

Trello

Coming Soon
Gitlab

Gitlab

Coming Soon
Zoho Desk

Zoho Desk

Coming Soon
Basecamp

Basecamp

Coming Soon
Hint: Use the /linked-accounts endpoint to pull platform support information.