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

remote_idString

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

The datetime that this object was modified by Merge.

first_nameString

The contact's first name.

last_nameString

The contact's last name.

accountUUID

The contact's account.

ownerUUID

The contact's owner.

addressesAddress[]

The Address object

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

Properties

created_atDateTime (ISO 8601)

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

The datetime that this object was modified by Merge.

street_1String

Line 1 of the address's street.

street_2String

Line 2 of the address's street.

cityString

The address's city.

stateString

The address's state.

postal_codeString

The address's postal code.

countryEnum

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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

address_typeEnum

The address type. Possible values include: BILLING, SHIPPING. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

email_addressesEmailAddress[]

The EmailAddress object

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

Properties

created_atDateTime (ISO 8601)

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

The datetime that this object was modified by Merge.

email_addressString

The email address.

email_address_typeString

The email address's type.

phone_numbersPhoneNumber[]

The PhoneNumber object

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

Properties

created_atDateTime (ISO 8601)

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

The datetime that this object was modified by Merge.

phone_numberString

The phone number.

phone_number_typeString

The phone number's type.

last_activity_atDateTime (ISO 8601)

When the contact's last activity occurred.

remote_created_atDateTime (ISO 8601)

When the third party's contact was created.

remote_was_deletedBoolean

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

remote_dataRemoteData[]

The RemoteData object

The RemoteData object is used to represent the full data pulled from the third-party API for an object.

Properties

pathString

The third-party API path that is being called.

dataAny

The data returned from the third-party for this object in its original, unnormalized format.

remote_fieldsRemoteField[]

GET

/contacts

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

APAC

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

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.

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. The maximum limit is 100.

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

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

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.

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 User 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

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}

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.

include_remote_fieldsBoolean

Optional

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

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

Field support by integration

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}

APAC

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

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

HubSpot

Pipedrive

Salesforce

Not seeing an integration that you're looking for?

POST

/contacts/ignore/{model_id}

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

APAC

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

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

HubSpot