Merge CRM - Accounts

Accounts

The Account object is used to represent 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

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

ownerUUID

Optional

The account's owner.

nameString

Optional

The account's name.

descriptionString

Optional

The account's description.

industryString

Optional

The account's industry.

websiteString

Optional

The account's website.

number_of_employeesInteger

Optional

The account's number of employees.

addressesAddress[]

Required

The Address object

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

Properties

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified 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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

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

phone_numbersPhoneNumber[]

Required

The PhoneNumber object

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

Properties

created_atDateTime (ISO 8601)

Required

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

Required

The datetime that this object was modified by Merge.

phone_numberString

Optional

The phone number.

phone_number_typeString

Optional

The phone number's type.

last_activity_atDateTime (ISO 8601)

Optional

The last date (either most recent or furthest in the future) of when an activity occurs in an account.

remote_updated_atDateTime (ISO 8601)

Optional

When the CRM system account data was last modified by a user with a login.

remote_created_atDateTime (ISO 8601)

Optional

When the third party's account was created.

remote_was_deletedBoolean

Required

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

Optional

remote_dataRemoteData[]

Optional

remote_fieldsRemoteField[]

Required

GET

/accounts

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

APAC

Returns a list of Account objects.

Query & Path Parameters

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.

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.

nameString

Optional

If provided, will only return accounts with this name.

owner_idString

Optional

If provided, will only return accounts with this owner.

page_sizeInteger

Optional

Number of results to return per page.

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

/accounts

Beta

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

APAC

Creates an Account 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.

ownerUUID

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

nameString

The account's name.

descriptionString

The account's description.

industryString

The account's industry.

websiteString

The account's website.

number_of_employeesInteger

The account's number of employees.

addressesArray

last_activity_atDateTime (ISO 8601)

The last date (either most recent or furthest in the future) of when an activity occurs in an account.

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

Capsule

Copper

HubSpot

Pipedrive

Salesforce

Zendesk Sell

Zoho CRM

To include the correct model fields when making POST requests, use the GET /accounts/meta/post endpoint. Learn more in our /meta guide.

GET

/accounts/{id}

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

APAC

Returns an Account 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

/accounts/{id}

Beta

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

APAC

Updates an Account 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.

ownerUUID

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

nameString

The account's name.

descriptionString

The account's description.

industryString

The account's industry.

websiteString

The account's website.

number_of_employeesInteger

The account's number of employees.

addressesArray

last_activity_atDateTime (ISO 8601)

The last date (either most recent or furthest in the future) of when an activity occurs in an account.

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

Capsule

Copper

HubSpot

Pipedrive

Salesforce

Zendesk Sell

Zoho CRM

GET

/accounts/meta/patch/{id}

https://api.merge.dev/api/crm/v1/accounts/meta/patch/{id}

APAC

Returns metadata for CRMAccount PATCHs.

Query & Path Parameters

idUUID

Required

Field support by integration

See all supported fields

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

Capsule

Copper

HubSpot

Pipedrive

Salesforce

Zendesk Sell

Zoho CRM

GET

/accounts/meta/post

https://api.merge.dev/api/crm/v1/accounts/meta/post

APAC

Returns metadata for CRMAccount POSTs.

Field support by integration

See all supported fields

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

Capsule

Copper

HubSpot

Pipedrive

Salesforce

Zendesk Sell

Zoho CRM

GET

/accounts/remote-field-classes

Beta

https://api.merge.dev/api/crm/v1/accounts/remote-field-classes

APAC

Returns a list of RemoteFieldClass objects.

Query & Path Parameters

cursorString

Optional

The pagination cursor value.

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

is_common_model_fieldBoolean

Optional

If provided, will only return remote field classes with this is_common_model_field value

page_sizeInteger

Optional

Number of results to return per page.

Overview

Next Up

Get Started

API Reference

Previous

Next Up