Contacts
The Contact object is used to represent an existing point of contact at a company in a CRM system.
The Contact object
Properties

first_nameString
Optional
The contact's first name.

last_nameString
Optional
The contact's last name.

accountString
Optional
The contact's account.

addressesAddress[]
Required
The Address object
The Address object is used to represent an entity's address.
JSON
{
"street_1": "50 Bowling Green Dr",
"street_2": "Golden Gate Park",
"city": "San Francisco",
"state": "CA",
"postal_code": "94122",
"country": "USA",
"address_type": "Shipping",
"modified_at": "2021-10-16T00:00:00Z"
}
Properties

street_1String
Optional
Line 1 of the address's street.

street_2String
Optional
Line 2 of the address's street.

cityString
Optional
The address's city.

stateString
Optional
The address's state.

postal_codeString
Optional
The address's postal code.

countryEnum
Optional
The address's country. Possible values include: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, or - in cases where there is no clear mapping - the original value passed through.

address_typeEnum
Optional
The address type. Possible values include: BILLING, SHIPPING, or - in cases where there is no clear mapping - the original value passed through.

modified_atString
Required
This is the datetime that this object was last updated by Merge

email_addressesEmailAddress[]
Required
The EmailAddress object
The EmailAddress object is used to represent an entity's email address.
JSON
{
"email_address": "[email protected]",
"email_address_type": "Work",
"modified_at": "2021-10-16T00:00:00Z"
}
Properties

email_addressString
Optional
The email address.

email_address_typeString
Optional
The email address's type.

modified_atString
Required
This is the datetime that this object was last updated by Merge

phone_numbersPhoneNumber[]
Required
The PhoneNumber object
The PhoneNumber object is used to represent an entity's phone number.
JSON
{
"phone_number": "+3198675309",
"phone_number_type": "Mobile",
"modified_at": "2021-10-16T00:00:00Z"
}
Properties

phone_numberString
Optional
The phone number.

phone_number_typeString
Optional
The phone number's type.

modified_atString
Required
This is the datetime that this object was last updated by Merge

last_activity_atString
Optional
When the contact's last activity occurred.

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

remote_was_deletedBoolean
Required

idString
Required

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

field_mappingsObject
Optional

modified_atString
Required
This is the datetime that this object was last updated by Merge

remote_dataRemoteData[]
Optional

remote_fieldsRemoteField[]
Required

The Contact object
JSON
{
"first_name": "Gil",
"last_name": "Feig",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"addresses": [
{
"street_1": "50 Bowling Green Dr",
"street_2": "Golden Gate Park",
"city": "San Francisco",
"state": "CA",
"postal_code": "94122",
"country": "USA",
"address_type": "Shipping"
}
],
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "Work"
}
],
"phone_numbers": [
{
"phone_number": "+13785579223",
"phone_number_type": "Mobile"
}
],
"last_activity_at": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}

GET
/contacts

Returns a list of Contact objects.


Header Parameters

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

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

account_idString
Optional
If provided, will only return contacts with this account.

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.

include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString
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.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"first_name": "Gil",
"last_name": "Feig",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"addresses": [
{
"street_1": "50 Bowling Green Dr",
"street_2": "Golden Gate Park",
"city": "San Francisco",
"state": "CA",
"postal_code": "94122",
"country": "USA",
"address_type": "Shipping"
}
],
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "Work"
}
],
"phone_numbers": [
{
"phone_number": "+13785579223",
"phone_number_type": "Mobile"
}
],
"last_activity_at": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}
]
}
Field support by platform
Accelo
Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_activity_atString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
ActiveCampaign
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_activity_atString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Affinity
Affinity

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Capsule
Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

first_nameString

last_activity_atString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Close
Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Copper
Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_activity_atString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
HubSpot
HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

first_nameString

last_activity_atString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Insightly
Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Keap
Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Nutshell
Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_activity_atString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Pipedrive
Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

first_nameString

last_activity_atString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Pipeliner
Pipeliner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

first_nameString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Salesflare
Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Salesforce
Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

first_nameString

last_activity_atString

last_nameString

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
SugarCRM
SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Teamleader
Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Teamwork CRM
Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Vtiger
Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_activity_atString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zendesk Sell
Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

remote_idString
Zoho CRM
Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_activity_atString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString

remote_dataRemoteData[]
pathstring
dataobject

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

Creates a Contact 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
View app-specific writable fields under “Field support by platform” in this section.

first_nameString
The contact's first name.

last_nameString
The contact's last name.

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

addressesArray

email_addressesArray

phone_numbersArray

last_activity_atString
When the contact's last activity occurred.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

POST v1/contacts
JSON
{
"model": {
"first_name": "Gil",
"last_name": "Feig",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"addresses": [
{
"street_1": "50 Bowling Green Dr",
"street_2": "Golden Gate Park",
"city": "San Francisco",
"state": "CA",
"postal_code": "94122",
"country": "USA",
"address_type": "Shipping"
}
],
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "Work"
}
],
"phone_numbers": [
{
"phone_number": "+13785579223",
"phone_number_type": "Mobile"
}
],
"last_activity_at": "2022-02-10T00:00:00Z"
}
}
Response
JSON
{
"model": {
"first_name": "Gil",
"last_name": "Feig",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"addresses": [
{
"street_1": "50 Bowling Green Dr",
"street_2": "Golden Gate Park",
"city": "San Francisco",
"state": "CA",
"postal_code": "94122",
"country": "USA",
"address_type": "Shipping"
}
],
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "Work"
}
],
"phone_numbers": [
{
"phone_number": "+13785579223",
"phone_number_type": "Mobile"
}
],
"last_activity_at": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}
}
Field support by platform
HubSpot
HubSpot

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString
Optional

last_activity_atString
Optional

last_nameString
Optional

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString
Optional

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Optional
Pipedrive
Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

first_nameString
Required

last_activity_atString
Optional

last_nameString
Optional

remote_created_atString
Optional

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Optional
Salesforce
Salesforce

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString
Optional

last_activity_atString
Optional

last_nameString
Required

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString
Optional

remote_fieldsRemoteField[]
remote_field_classobject
valueobject

remote_idString
Optional
Zendesk Sell
Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

addressesAddress[]
street_1string
street_2string
citystring
statestring
postal_codestring
countrystring
address_typestring
modified_atstring

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString
Optional

last_nameString
Optional

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString
Optional

remote_idString
Optional
Zoho CRM
Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters


accountString
Optional

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString
Optional

last_activity_atString
Optional

last_nameString
Optional

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
modified_atstring

remote_created_atString
Optional

remote_idString
Optional
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/contacts/{id}

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

include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

Response
JSON
{
"first_name": "Gil",
"last_name": "Feig",
"account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"addresses": [
{
"street_1": "50 Bowling Green Dr",
"street_2": "Golden Gate Park",
"city": "San Francisco",
"state": "CA",
"postal_code": "94122",
"country": "USA",
"address_type": "Shipping"
}
],
"email_addresses": [
{
"email_address": "[email protected]",
"email_address_type": "Work"
}
],
"phone_numbers": [
{
"phone_number": "+13785579223",
"phone_number_type": "Mobile"
}
],
"last_activity_at": "2022-02-10T00:00:00Z",
"remote_created_at": "2021-11-10T00:00:00Z",
"remote_was_deleted": true,
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
Show advanced fields
}
Field support by platform
Accelo
Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


accountString

email_addressesEmailAddress[]
email_addressstring
email_address_typestring
modified_atstring

first_nameString

last_activity_atString

last_nameString

phone_numbersPhoneNumber[]
phone_numberstring
phone_number_typestring
<