Leads
The Lead object is used to represent an individual who is a potential customer.
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 lead's owner.
lead_sourceString
Optional
The lead's source.
titleString
Optional
The lead's title.
companyString
Optional
The lead's company.
first_nameString
Optional
The lead's first name.
last_nameString
Optional
The lead's last name.
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.
email_addressesEmailAddress[]
Required
The EmailAddress object
The EmailAddress object is used to represent an entity's email 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.
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
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.
remote_updated_atDateTime (ISO 8601)
Optional
When the third party's lead was updated.
remote_created_atDateTime (ISO 8601)
Optional
When the third party's lead was created.
converted_dateDateTime (ISO 8601)
Optional
When the lead was converted.
converted_contactUUID
Optional
The contact of the converted lead.
converted_accountUUID
Optional
The account of the converted lead.
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
/leads

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

US
EU
APAC

Returns a list of Lead objects.


Query & Path Parameters
converted_account_idString
Optional
If provided, will only return leads with this account.
converted_contact_idString
Optional
If provided, will only return leads with this contact.
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
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.
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.
owner_idString
Optional
If provided, will only return leads with this owner.
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
Accelo
Insightly
Insightly
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Pipedrive
Pipedrive
Pipeliner
Pipeliner
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
POST
/leads

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

US
EU
APAC

Creates a Lead 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 lead's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.
lead_sourceString
The lead's source.
titleString
The lead's title.
companyString
The lead's company.
first_nameString
The lead's first name.
last_nameString
The lead's last name.
addressesArray
email_addressesArray
phone_numbersArray
converted_dateDateTime (ISO 8601)
When the lead was converted.
converted_contactUUID
The contact of the converted lead. Must pass in a valid Merge ID, which can be obtained from the id field in the Contact object.
converted_accountUUID
The account of the converted lead. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.
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
Pipedrive
Pipedrive
Salesforce
Salesforce
Zoho CRM
Zoho CRM
Not seeing an integration that you're looking for? Submit a request for it.
To include the correct model fields when making POST requests, use the GET /leads/meta/post endpoint. Learn more in our /meta guide.
GET
/leads/{id}

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

US
EU
APAC

Returns a Lead 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
Accelo
Insightly
Insightly
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Pipedrive
Pipedrive
Pipeliner
Pipeliner
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
GET
/leads/meta/post

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

US
EU
APAC

Returns metadata for Lead POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Pipedrive
Pipedrive
Salesforce
Salesforce
Zoho CRM
Zoho CRM
Not seeing an integration that you're looking for? Submit a request for it.
GET
/leads/remote-field-classes
Beta

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

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & Path Parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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.
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.
Previous
Engagements
Next Up
Notes