Contacts
The Contact object is used to represent the customer, lead, or external user that a ticket is associated with.
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.

nameString
Optional
The contact's name.

email_addressString
Optional
The contact's email address.

phone_numberString
Optional
The contact's phone number.

detailsString
Optional
The contact's details.

accountUUID
Optional
The contact's account.

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
/contacts

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

US
EU
APAC

Returns a list of Contact 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
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.

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_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Dixa
Dixa
Freshdesk
Freshdesk
Freshservice
Freshservice
Front
Front
Gladly
Gladly
Gorgias
Gorgias
Help Scout
Help Scout
Intercom
Intercom
Jira Service Management
Jira Service Management
Kustomer
Kustomer
Re:amaze
Re:amaze
Salesforce Service Cloud
Salesforce Service Cloud
ServiceNow
ServiceNow
Zendesk
Zendesk
Zoho Desk
Zoho Desk
POST
/contacts

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

US
EU
APAC

Creates a Contact 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.

nameString
The contact's name.

email_addressString
The contact's email address.

phone_numberString
The contact's phone number.

detailsString
The contact's details.

accountUUID
The contact's account. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.

integration_paramsObject

linked_account_paramsObject

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Intercom
Intercom
Zendesk
Zendesk
Not seeing an integration that you're looking for? Submit a request for it.
To include the correct model fields when making POST requests, use the GET /contacts/meta/post endpoint. Learn more in our /meta guide.
GET
/contacts/{id}

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

US
EU
APAC

Returns a Contact 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
Dixa
Dixa
Freshdesk
Freshdesk
Freshservice
Freshservice
Front
Front
Gladly
Gladly
Gorgias
Gorgias
Help Scout
Help Scout
Intercom
Intercom
Jira Service Management
Jira Service Management
Kustomer
Kustomer
Re:amaze
Re:amaze
Salesforce Service Cloud
Salesforce Service Cloud
ServiceNow
ServiceNow
Zendesk
Zendesk
Zoho Desk
Zoho Desk
GET
/contacts/meta/post

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

US
EU
APAC

Returns metadata for TicketingContact POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Intercom
Intercom
Zendesk
Zendesk
Not seeing an integration that you're looking for? Submit a request for it.