Attachments

The Attachment object is used to represent an attachment for a ticket.

The Attachment object

Properties


idString
Required

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

file_nameString
Optional
The attachment's name.

ticketString
Optional

file_urlString
Optional
The attachment's url.

content_typeString
Optional
The attachment's file format.

uploaded_byString
Optional

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

remote_was_deletedBoolean
Required

The Attachment object
JSON
{
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"file_name": "Screenshot.png",
"ticket": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"file_url": "http://alturl.com/p749b",
"content_type": "jpeg",
"uploaded_by": "28b54125-287f-494d-965e-3c5b330c9a68",
"remote_created_at": "2022-11-10T00:00:00Z",
"remote_was_deleted": true
}

GET

/attachments

Returns a list of Attachment 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": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"file_name": "Screenshot.png",
"ticket": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"file_url": "http://alturl.com/p749b",
"content_type": "jpeg",
"uploaded_by": "28b54125-287f-494d-965e-3c5b330c9a68",
"remote_created_at": "2022-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


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_idString

ticketString

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

/attachments

Creates an Attachment 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.

file_nameString
Optional
The attachment's name.

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

file_urlString
Optional
The attachment's url.

content_typeString
Optional
The attachment's file format.

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

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

Response
JSON
{
"model": {
"id": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"file_name": "Screenshot.png",
"ticket": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"file_url": "http://alturl.com/p749b",
"content_type": "jpeg",
"uploaded_by": "28b54125-287f-494d-965e-3c5b330c9a68",
"remote_created_at": "2022-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


file_nameString
Required

file_urlString
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


content_typeString
Optional

file_nameString
Required

file_urlString
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

uploaded_byString
Optional

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


file_nameString
Optional

file_urlString
Optional

remote_created_atString
Optional

remote_idString
Optional

ticketString
Optional

uploaded_byString
Optional

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


content_typeString
Optional

file_nameString
Required

file_urlString
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters


content_typeString
Optional

file_nameString
Optional

file_urlString
Required

remote_created_atString
Optional

remote_idString
Optional

ticketString
Required

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

/attachments/{id}

Returns an Attachment 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": "17a54124-287f-494d-965e-3c5b330c9a68",
"remote_id": "19202938",
"file_name": "Screenshot.png",
"ticket": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"file_url": "http://alturl.com/p749b",
"content_type": "jpeg",
"uploaded_by": "28b54125-287f-494d-965e-3c5b330c9a68",
"remote_created_at": "2022-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


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_idString

ticketString

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

/attachments/meta/post

Returns metadata for TicketingAttachment 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


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

ClickUp

ClickUp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Freshdesk

Freshdesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

Front

Front

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Hive

Hive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Jira Service Management

Jira Service Management

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Jira Software

Jira Software

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

ServiceNow

ServiceNow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

Shortcut

Shortcut

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Teamwork

Teamwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Trello

Trello

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Wrike

Wrike

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_created_atString

remote_idString

ticketString

uploaded_byString

Zendesk

Zendesk

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


content_typeString

file_nameString

file_urlString

remote_idString

ticketString

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