For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Contact object
          • GET/contacts
          • POST/contacts
          • GET/contacts/{id}
          • GET/contacts/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsContacts

The Contact object

The Contact Object
1{
2 "id": "string",
3 "remote_id": "string",
4 "created_at": "2023-01-01T00:00:00Z",
5 "modified_at": "2023-01-01T00:00:00Z",
6 "name": "string",
7 "email_address": "string",
8 "phone_number": "string",
9 "details": "string",
10 "account": "string",
11 "remote_was_deleted": true,
12 "field_mappings": {},
13 "remote_data": [
14 {
15 "path": "string",
16 "data": {}
17 }
18 ]
19}
Was this page helpful?
Previous

/comments/meta/post

Next

/contacts

Built with

The Contact object is used to represent the customer, lead, or external user that a ticket is associated with.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
namestring or nullOptional
The contact's name.
email_addressstring or nullOptional
The contact's email address.
phone_numberstring or nullOptional
The contact's phone number.
detailsstring or nullOptional
The contact's details.
accountstring or nullOptionalformat: "uuid"
The contact's account.
remote_was_deletedbooleanOptionalRead-only

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 or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only