Engagements
The
Engagement object is used to represent an interaction noted in a CRM system.Properties
idUUIDremote_idStringThe 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.
ownerUUIDThe engagement's owner.
contentStringThe engagement's content.
subjectStringThe engagement's subject.
directionEnumThe engagement's direction. Possible values include:
INBOUND, OUTBOUND. 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.engagement_typeUUIDThe engagement type of the engagement.
start_timeDateTime (ISO 8601)The time at which the engagement started.
end_timeDateTime (ISO 8601)The time at which the engagement ended.
accountUUIDThe account of the engagement.
contactsArrayremote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
remote_fieldsRemoteField[]GET
/engagements
https://api.merge.dev/api/crm/v1/engagements
US
EU
APAC
Returns a list of Engagement 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.
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
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_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.
include_shell_dataBooleanOptional
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_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
started_afterDateTime (ISO 8601)Optional
If provided, will only return engagements started after this datetime.
started_beforeDateTime (ISO 8601)Optional
If provided, will only return engagements started before this datetime.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Accelo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringsubjectString
Capsule
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idString
Close
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringdirectionEnumengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringsubjectString
Copper
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringsubjectString
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringstart_timeDateTime (ISO 8601)subjectString
Insightly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Keap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contactsArrayend_timeDateTime (ISO 8601)engagement_typeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Microsoft Dynamics 365 Sales
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Nutshell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Pipedrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringstart_timeDateTime (ISO 8601)subjectString
Salesflare
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringstart_timeDateTime (ISO 8601)subjectString
SugarCRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Teamleader
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Teamwork CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentStringengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Vtiger
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectString
Zendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)
Zoho CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringPOST
/engagements
Betahttps://api.merge.dev/api/crm/v1/engagements
US
EU
APAC
Creates an Engagement object with the given values.
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
View app-specific writable fields under “Field support by platform” in this section.ownerUUIDThe engagement's owner. Must pass in a valid Merge ID, which can be obtained from the
id field in the User object.contentStringThe engagement's content.
subjectStringThe engagement's subject.
directionEnumThe engagement's direction. Must pass in one of the following choices:
INBOUND, OUTBOUND.engagement_typeUUIDThe engagement type of the engagement. Must pass in a valid Merge ID, which can be obtained from the
id field in the EngagementType object.start_timeDateTime (ISO 8601)The time at which the engagement started.
end_timeDateTime (ISO 8601)The time at which the engagement ended.
accountUUIDThe account of the engagement. Must pass in a valid Merge ID, which can be obtained from the
id field in the Account object.contactsArrayintegration_paramsObjectlinked_account_paramsObjectremote_fieldsArrayField support by integration
Use the /linked-accounts endpoint to pull platform support information
Copper
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
subjectStringOptional
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contactsArrayOptional
contentStringOptional
directionEnumOptional
end_timeDateTime (ISO 8601)Optional
engagement_typeUUIDRequired
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
subjectStringOptional
Additional POST Parameters
remote_fieldsObjectRequired
remote_field_classStringRequired
Pipedrive
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contactsArrayOptional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringOptional
subjectStringOptional
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contactsArrayOptional
contentStringOptional
engagement_typeUUIDRequired
ownerUUIDOptional
remote_idStringOptional
subjectStringOptional
Additional POST Parameters
remote_fieldsObjectRequired
remote_field_classStringRequired
valueStringRequired
Vtiger
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contentStringOptional
end_timeDateTime (ISO 8601)Optional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
subjectStringOptional
Zendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contentStringOptional
directionEnumOptional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
Zoho CRM
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contentStringOptional
directionEnumOptional
end_timeDateTime (ISO 8601)Optional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
subjectStringOptional
To include the correct model fields when making POST requests, use the GET /engagements/meta/post endpoint. Learn more in our /meta guide.
GET
/engagements/{id}
https://api.merge.dev/api/crm/v1/engagements/{id}
US
EU
APAC
Returns an Engagement object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
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.
include_shell_dataBooleanOptional
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
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringCapsule
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringClose
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringdirectionEnumengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringCopper
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringsubjectStringHubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringstart_timeDateTime (ISO 8601)subjectStringInsightly
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringKeap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contactsArrayend_timeDateTime (ISO 8601)engagement_typeUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringMicrosoft Dynamics 365 Sales
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringNutshell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringPipedrive
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringstart_timeDateTime (ISO 8601)subjectStringSalesflare
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringSalesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringstart_timeDateTime (ISO 8601)subjectStringSugarCRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringTeamleader
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringTeamwork CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
contentStringengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringVtiger
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontentStringend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringZendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumengagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)Zoho CRM
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
accountUUIDcontactsArraycontentStringdirectionEnumend_timeDateTime (ISO 8601)engagement_typeUUIDownerUUIDremote_dataRemoteData[]pathstringdatastringremote_idStringstart_timeDateTime (ISO 8601)subjectStringPATCH
/engagements/{id}
Betahttps://api.merge.dev/api/crm/v1/engagements/{id}
US
EU
APAC
Updates an Engagement object with the given id.
Query & path parameters
idUUIDRequired
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
View app-specific writable fields under “Field support by platform” in this section.ownerUUIDThe engagement's owner. Must pass in a valid Merge ID, which can be obtained from the
id field in the Owner object.contentStringThe engagement's content.
subjectStringThe engagement's subject.
directionEnumThe engagement's direction. Must pass in one of the following choices:
INBOUND, OUTBOUND.engagement_typeUUIDThe engagement type of the engagement. Must pass in a valid Merge ID, which can be obtained from the
id field in the Engagement_type object.start_timeDateTime (ISO 8601)The time at which the engagement started.
end_timeDateTime (ISO 8601)The time at which the engagement ended.
accountUUIDThe account of the engagement. Must pass in a valid Merge ID, which can be obtained from the
id field in the Account object.contactsArrayintegration_paramsObjectlinked_account_paramsObjectremote_fieldsArrayField support by integration
Use the /linked-accounts endpoint to pull platform support information
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported PATCH Model Parameters
accountUUIDOptional
contentStringOptional
directionEnumOptional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
subjectStringOptional
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported PATCH Model Parameters
accountUUIDOptional
contentStringOptional
engagement_typeUUIDOptional
ownerUUIDOptional
subjectStringOptional
Not seeing an integration that you're looking for?
GET
/engagements/meta/patch/{id}
https://api.merge.dev/api/crm/v1/engagements/meta/patch/{id}
US
EU
APAC
Returns metadata for Engagement PATCHs.
Query & path parameters
idUUIDRequired
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported PATCH Model Parameters
accountUUIDOptional
contentStringOptional
directionEnumOptional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
subjectStringOptional
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported PATCH Model Parameters
accountUUIDOptional
contentStringOptional
engagement_typeUUIDOptional
ownerUUIDOptional
subjectStringOptional
Not seeing an integration that you're looking for?
GET
/engagements/meta/post
https://api.merge.dev/api/crm/v1/engagements/meta/post
US
EU
APAC
Returns metadata for Engagement POSTs.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Copper
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
subjectStringOptional
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contactsArrayOptional
contentStringOptional
directionEnumOptional
end_timeDateTime (ISO 8601)Optional
engagement_typeUUIDRequired
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
subjectStringOptional
Additional POST Parameters
remote_fieldsObjectRequired
remote_field_classStringRequired
Pipedrive
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contactsArrayOptional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_fieldsRemoteField[]remote_field_classobjectvalueobjectremote_idStringOptional
subjectStringOptional
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contactsArrayOptional
contentStringOptional
engagement_typeUUIDRequired
ownerUUIDOptional
remote_idStringOptional
subjectStringOptional
Additional POST Parameters
remote_fieldsObjectRequired
remote_field_classStringRequired
valueStringRequired
Vtiger
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contentStringOptional
end_timeDateTime (ISO 8601)Optional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
subjectStringOptional
Zendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contentStringOptional
directionEnumOptional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
Zoho CRM
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
accountUUIDOptional
contentStringOptional
directionEnumOptional
end_timeDateTime (ISO 8601)Optional
engagement_typeUUIDOptional
ownerUUIDOptional
remote_idStringOptional
start_timeDateTime (ISO 8601)Optional
subjectStringOptional
GET
/engagements/remote-field-classes
Betahttps://api.merge.dev/api/crm/v1/engagements/remote-field-classes
US
EU
APAC
Returns a list of RemoteFieldClass objects.
Query & path parameters
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
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_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.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
is_common_model_fieldBooleanOptional
If provided, will only return remote field classes with this is_common_model_field value
is_customBooleanOptional
If provided, will only return remote fields classes with this is_custom value
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.