Merge CRM - Contacts

Contacts

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

Properties

idUUID

Required

remote_idString

Optional

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

Required

modified_atDateTime (ISO 8601)

Required

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

first_nameString

Optional

The contact's first name.

last_nameString

Optional

The contact's last name.

accountUUID

Optional

The contact's account.

ownerUUID

Optional

The contact's owner.

addressesAddress[]

Required

The Address object

The Address object is used to represent an entity's address.

Properties

created_atDateTime (ISO 8601)

Required

modified_atDateTime (ISO 8601)

Required

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

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. In cases where there is no clear mapping, the original value passed through will be returned.

address_typeEnum

Optional

The address type. Possible values include: BILLING, SHIPPING. In cases where there is no clear mapping, the original value passed through will be returned.

email_addressesEmailAddress[]

Required

The EmailAddress object

The EmailAddress object is used to represent an entity's email address.

Properties

created_atDateTime (ISO 8601)

Required

modified_atDateTime (ISO 8601)

Required

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

email_addressString

Optional

The email address.

email_address_typeString

Optional

The email address's type.

phone_numbersPhoneNumber[]

Required

The PhoneNumber object

The PhoneNumber object is used to represent an entity's phone number.

Properties

created_atDateTime (ISO 8601)

Required

modified_atDateTime (ISO 8601)

Required

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

phone_numberString

Optional

The phone number.

phone_number_typeString

Optional

The phone number's type.

last_activity_atDateTime (ISO 8601)

Optional

When the contact's last activity occurred.

remote_created_atDateTime (ISO 8601)

Optional

When the third party's contact was created.

remote_was_deletedBoolean

Required

field_mappingsObject

Optional

remote_dataRemoteData[]

Optional

remote_fieldsRemoteField[]

Required

GET

/contacts

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

Returns a list of Contact objects.

Query & Path Parameters

account_idString

Optional

If provided, will only return contacts with this account.

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.

email_addressesString

Optional

If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.

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

phone_numbersString

Optional

If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.

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

Accelo

ActiveCampaign

Affinity

Capsule

Copper

HubSpot

Insightly

Keap

Microsoft Dynamics 365 Sales

Nutshell

Pipedrive

Pipeliner

Salesflare

Salesforce

SugarCRM

Teamleader

Teamwork CRM

Vtiger

Zendesk Sell

Zoho CRM

POST

/contacts

Beta

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

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.

first_nameString

The contact's first name.

last_nameString

The contact's last name.

accountUUID

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

ownerUUID

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

addressesArray

email_addressesArray

phone_numbersArray

last_activity_atDateTime (ISO 8601)

When the contact's last activity occurred.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

HubSpot

Pipedrive

Salesforce

Zendesk Sell

Zoho CRM

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/crm/v1/contacts/{id}

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.

include_remote_fieldsBoolean

Optional

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

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

Accelo

ActiveCampaign

Affinity

Capsule

Copper

HubSpot

Insightly

Keap

Microsoft Dynamics 365 Sales

Nutshell

Pipedrive

Pipeliner

Salesflare

Salesforce

SugarCRM

Teamleader

Teamwork CRM

Vtiger

Zendesk Sell

Zoho CRM

PATCH

/contacts/{id}

Beta

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

Updates a Contact object with the given id.

Query & Path Parameters

idUUID

Required

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.

accountUUID

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

ownerUUID

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

addressesArray

email_addressesArray

phone_numbersArray

last_activity_atDateTime (ISO 8601)

When the contact's last activity occurred.

integration_paramsObject

linked_account_paramsObject

remote_fieldsArray

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information

HubSpot

Pipedrive

Salesforce

Not seeing an integration that you're looking for? Submit a request for it.

POST

/contacts/ignore/{model_id}

https://api.merge.dev/api/crm/v1/contacts/ignore/{model_id}

Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.

Query & Path Parameters

model_idUUID

Required

Body Parameters

reasonEnum

Required

Must pass in one of the following choices: GENERAL_CUSTOMER_REQUEST, GDPR, OTHER.

messageString

Required

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information