Contacts
TheContact object is used to represent an existing point of contact at a company in a CRM system.The Contact object
Properties
first_nameStringOptional
The contact's first name.
last_nameStringOptional
The contact's last name.
accountStringOptional
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"}
Properties
street_1StringOptional
Line 1 of the address's street.
street_2StringOptional
Line 2 of the address's street.
cityStringOptional
The address's city.
stateStringOptional
The address's state.
postal_codeStringOptional
The address's postal code.
countryEnumOptional
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_typeEnumOptional
The address type. Possible values include:
BILLING, SHIPPING, or - in cases where there is no clear mapping - the original value passed through.email_addressesEmailAddress[]Required
The EmailAddress object
The
EmailAddress object is used to represent an entity's email address.JSON
Properties
email_addressStringOptional
The email address.
email_address_typeStringOptional
The email address's type.
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"}
Properties
phone_numberStringOptional
The phone number.
phone_number_typeStringOptional
The phone number's type.
last_activity_atStringOptional
When the contact's last activity occurred.
remote_created_atStringOptional
When the third party's contact was created.
remote_dataRemoteData[]Optional
remote_was_deletedBooleanRequired
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
field_mappingsObjectOptional
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_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]}
GET
/contacts
Returns a list of Contact objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
account_idStringOptional
If provided, will only return contacts with this account.
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
modified_afterStringOptional
If provided, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
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_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]}]}
Field support by platform
Accelo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Affinity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Capsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringfirst_nameStringlast_activity_atStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Close
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Copper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringfirst_nameStringlast_activity_atStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Insightly
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Microsoft Dynamics 365 Sales
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Nutshell
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Pipedrive
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringfirst_nameStringlast_activity_atStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Pipeliner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringfirst_nameStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Salesflare
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Salesforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringfirst_nameStringlast_activity_atStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
SugarCRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Teamleader
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Teamwork CRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Vtiger
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Zendesk Sell
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idString
Zoho CRM
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringHint: Use the /linked-accounts endpoint to pull platform support information.
POST
/contacts
Creates a Contact object with the given values.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
first_nameStringOptional
The contact's first name.
last_nameStringOptional
The contact's last name.
accountStringOptional
The contact's account. Must pass in a valid Merge ID, which can be obtained from the
id field in the Account table.addressesArrayRequired
email_addressesArrayRequired
phone_numbersArrayRequired
last_activity_atStringOptional
When the contact's last activity occurred.
integration_paramsObjectOptional
linked_account_paramsObjectOptional
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_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]},"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
HubSpot
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
email_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringOptional
last_nameStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringOptional
remote_idStringOptional
Zendesk Sell
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
accountStringOptional
addressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringOptional
last_nameStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringOptional
remote_idStringOptional
Zoho CRM
Merge supports Passthrough Requests to this platform's API
Supported POST Body Parameters
accountStringOptional
email_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringOptional
last_activity_atStringOptional
last_nameStringOptional
phone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringOptional
remote_idStringOptional
Pipedrive
Salesforce
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/contacts/{id}
Returns a Contact object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fieldsBooleanOptional
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_data": [{"path": "/contacts","data": ["Varies by platform"]}],"remote_was_deleted": true,"id": "03455bc6-6040-430a-848e-aafacbfdf4fg","remote_id": "19202938","field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}},"remote_fields": [{"value": {}}]}
Field support by platform
Accelo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringAffinity
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringremote_dataRemoteData[]pathstringdataobjectremote_idStringCapsule
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringfirst_nameStringlast_activity_atStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringClose
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringCopper
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_activity_atStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringHubSpot
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringfirst_nameStringlast_activity_atStringlast_nameStringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringInsightly
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringKeap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]phone_numberstringphone_number_typestringremote_created_atStringremote_dataRemoteData[]pathstringdataobjectremote_idStringMicrosoft Dynamics 365 Sales
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
accountStringaddressesAddress[]street_1stringstreet_2stringcitystringstatestringpostal_codestringcountrystringaddress_typestringemail_addressesEmailAddress[]email_addressstringemail_address_typestringfirst_nameStringlast_nameStringphone_numbersPhoneNumber[]