Engagements
The Engagement object is used to represent an interaction noted 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 engagement's owner.
contentString
Optional
The engagement's content.
subjectString
Optional
The engagement's subject.
directionEnum
Optional
The 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_typeUUID
Optional
The engagement type of the engagement.
start_timeDateTime (ISO 8601)
Optional
The time at which the engagement started.
end_timeDateTime (ISO 8601)
Optional
The time at which the engagement ended.
accountUUID
Optional
The account of the engagement.
contactsArray
Required
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
/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.
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
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.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
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
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Accelo
Accelo
ActiveCampaign
ActiveCampaign
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Keap
Keap
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Salesflare
Salesflare
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamleader
Teamleader
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
POST
/engagements
Beta

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

US
EU
APAC

Creates an Engagement 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 engagement's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the User object.
contentString
The engagement's content.
subjectString
The engagement's subject.
directionEnum
The engagement's direction. Must pass in one of the following choices: INBOUND, OUTBOUND.
engagement_typeUUID
The 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.
accountUUID
The account of the engagement. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.
contactsArray
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
Copper
Copper
HubSpot
HubSpot
Pipedrive
Pipedrive
Salesforce
Salesforce
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
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
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
ActiveCampaign
ActiveCampaign
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Keap
Keap
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Salesflare
Salesflare
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamleader
Teamleader
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
PATCH
/engagements/{id}
Beta

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

US
EU
APAC

Updates an Engagement 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 engagement's owner. Must pass in a valid Merge ID, which can be obtained from the id field in the Owner object.
contentString
The engagement's content.
subjectString
The engagement's subject.
directionEnum
The engagement's direction. Must pass in one of the following choices: INBOUND, OUTBOUND.
engagement_typeUUID
The 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.
accountUUID
The account of the engagement. Must pass in a valid Merge ID, which can be obtained from the id field in the Account object.
contactsArray
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
HubSpot
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.
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
idUUID
Required
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
HubSpot
HubSpot
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.
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
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Copper
Copper
HubSpot
HubSpot
Pipedrive
Pipedrive
Salesforce
Salesforce
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
GET
/engagements/remote-field-classes
Beta

https://api.merge.dev/api/crm/v1/engagements/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
Engagement Types
Next Up
Leads