Engagement
object is used to represent an interaction noted in a CRM system.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)owner
UUIDcontent
Stringsubject
Stringdirection
EnumINBOUND
, OUTBOUND
. In cases where there is no clear mapping, the original value passed through will be returned.engagement_type
UUIDstart_time
DateTime (ISO 8601)end_time
DateTime (ISO 8601)account
UUIDcontacts
Arrayremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]remote_fields
RemoteField[]https://api.merge.dev/api/crm/v1/engagements
Returns a list of Engagement
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_id
Stringstarted_after
DateTime (ISO 8601)started_before
DateTime (ISO 8601)![Accelo](https://merge-api-production.s3.amazonaws.com/media/Platformaccelo_square.png)
Supported Response Fields
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
account
UUIDcontent
Stringengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
String![Capsule](https://merge-api-production.s3.amazonaws.com/media/PlatformCapsule.png)
Supported Response Fields
account
UUIDcontent
Stringengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String![Close](https://merge-api-production.s3.amazonaws.com/media/PlatformClose.jpg)
Supported Response Fields
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
String![Copper](https://merge-api-production.s3.amazonaws.com/media/PlatformCopper.jpg)
Supported Response Fields
account
UUIDengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
String![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Insightly](https://merge-api-production.s3.amazonaws.com/media/Insightly_square.png)
Supported Response Fields
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Keap](https://merge-api-production.s3.amazonaws.com/media/Platformkeap_square.png)
Supported Response Fields
contacts
Arrayend_time
DateTime (ISO 8601)engagement_type
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Microsoft Dynamics 365 Sales](https://merge-api-production.s3.amazonaws.com/media/PlatformDynamics365Sales_square.png)
Supported Response Fields
account
UUIDcontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Nutshell](https://merge-api-production.s3.amazonaws.com/media/Nutshell.png)
Supported Response Fields
content
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Pipedrive](https://merge-api-production.s3.amazonaws.com/media/PlatformPipedrive.jpg)
Supported Response Fields
account
UUIDcontacts
Arrayengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringsubject
String![Salesflare](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesflare.jpg)
Supported Response Fields
account
UUIDend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![SugarCRM](https://merge-api-production.s3.amazonaws.com/media/Platformsugarcrm_square.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Teamleader](https://merge-api-production.s3.amazonaws.com/media/Teamleader.png)
Supported Response Fields
content
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Teamwork CRM](https://merge-api-production.s3.amazonaws.com/media/PlatformTeamwork_CRM_square.jpg)
Supported Response Fields
content
Stringengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Vtiger](https://merge-api-production.s3.amazonaws.com/media/Platformvtiger_square.png)
Supported Response Fields
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Zendesk Sell](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_8wt2TTW.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)![Zoho CRM](https://merge-api-production.s3.amazonaws.com/media/Platformzohocrm_square.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
Stringhttps://api.merge.dev/api/crm/v1/engagements
Creates an Engagement
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectowner
UUIDid
field in the User object.content
Stringsubject
Stringdirection
EnumINBOUND
, OUTBOUND
.engagement_type
UUIDid
field in the EngagementType object.start_time
DateTime (ISO 8601)end_time
DateTime (ISO 8601)account
UUIDid
field in the Account object.contacts
Arrayintegration_params
Objectlinked_account_params
Objectremote_fields
Array![Copper](https://merge-api-production.s3.amazonaws.com/media/PlatformCopper.jpg)
Supported POST Model Parameters
engagement_type
UUIDowner
UUIDremote_id
Stringsubject
String![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
Supported POST Model Parameters
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_id
Stringsubject
String![Pipedrive](https://merge-api-production.s3.amazonaws.com/media/PlatformPipedrive.jpg)
Supported POST Model Parameters
account
UUIDcontacts
Arrayengagement_type
UUIDowner
UUIDremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringsubject
String![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
Supported POST Model Parameters
account
UUIDcontacts
Arraycontent
Stringengagement_type
UUIDowner
UUIDremote_id
Stringsubject
StringAdditional POST Parameters
remote_fields
Objectremote_field_class
Stringvalue
String![Vtiger](https://merge-api-production.s3.amazonaws.com/media/Platformvtiger_square.png)
Supported POST Model Parameters
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Zendesk Sell](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_8wt2TTW.png)
Supported POST Model Parameters
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_id
Stringstart_time
DateTime (ISO 8601)![Zoho CRM](https://merge-api-production.s3.amazonaws.com/media/Platformzohocrm_square.png)
Supported POST Model Parameters
account
UUIDcontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_id
Stringstart_time
DateTime (ISO 8601)subject
Stringhttps://api.merge.dev/api/crm/v1/engagements/{id}
Returns an Engagement
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleaninclude_remote_fields
Boolean![Accelo](https://merge-api-production.s3.amazonaws.com/media/Platformaccelo_square.png)
Supported Response Fields
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
account
UUIDcontent
Stringengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
String![Capsule](https://merge-api-production.s3.amazonaws.com/media/PlatformCapsule.png)
Supported Response Fields
account
UUIDcontent
Stringengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
String![Close](https://merge-api-production.s3.amazonaws.com/media/PlatformClose.jpg)
Supported Response Fields
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
String![Copper](https://merge-api-production.s3.amazonaws.com/media/PlatformCopper.jpg)
Supported Response Fields
account
UUIDengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsubject
String![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Insightly](https://merge-api-production.s3.amazonaws.com/media/Insightly_square.png)
Supported Response Fields
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Keap](https://merge-api-production.s3.amazonaws.com/media/Platformkeap_square.png)
Supported Response Fields
contacts
Arrayend_time
DateTime (ISO 8601)engagement_type
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Microsoft Dynamics 365 Sales](https://merge-api-production.s3.amazonaws.com/media/PlatformDynamics365Sales_square.png)
Supported Response Fields
account
UUIDcontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Nutshell](https://merge-api-production.s3.amazonaws.com/media/Nutshell.png)
Supported Response Fields
content
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Pipedrive](https://merge-api-production.s3.amazonaws.com/media/PlatformPipedrive.jpg)
Supported Response Fields
account
UUIDcontacts
Arrayengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringsubject
String![Salesflare](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesflare.jpg)
Supported Response Fields
account
UUIDend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![SugarCRM](https://merge-api-production.s3.amazonaws.com/media/Platformsugarcrm_square.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Teamleader](https://merge-api-production.s3.amazonaws.com/media/Teamleader.png)
Supported Response Fields
content
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Teamwork CRM](https://merge-api-production.s3.amazonaws.com/media/PlatformTeamwork_CRM_square.jpg)
Supported Response Fields
content
Stringengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Vtiger](https://merge-api-production.s3.amazonaws.com/media/Platformvtiger_square.png)
Supported Response Fields
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Zendesk Sell](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_8wt2TTW.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)![Zoho CRM](https://merge-api-production.s3.amazonaws.com/media/Platformzohocrm_square.png)
Supported Response Fields
account
UUIDcontacts
Arraycontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstart_time
DateTime (ISO 8601)subject
Stringhttps://api.merge.dev/api/crm/v1/engagements/{id}
Updates an Engagement
object with the given id
.
id
UUIDis_debug_mode
Booleanrun_async
Booleanmodel
Objectowner
UUIDid
field in the Owner object.content
Stringsubject
Stringdirection
EnumINBOUND
, OUTBOUND
.engagement_type
UUIDid
field in the Engagement_type object.start_time
DateTime (ISO 8601)end_time
DateTime (ISO 8601)account
UUIDid
field in the Account object.contacts
Arrayintegration_params
Objectlinked_account_params
Objectremote_fields
Array![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
Supported PATCH Model Parameters
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_id
Stringsubject
String![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
Supported PATCH Model Parameters
account
UUIDcontent
Stringengagement_type
UUIDowner
UUIDsubject
Stringhttps://api.merge.dev/api/crm/v1/engagements/meta/patch/{id}
Returns metadata for Engagement
PATCHs.
id
UUID![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
Supported PATCH Model Parameters
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_id
Stringsubject
String![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
Supported PATCH Model Parameters
account
UUIDcontent
Stringengagement_type
UUIDowner
UUIDsubject
Stringhttps://api.merge.dev/api/crm/v1/engagements/meta/post
Returns metadata for Engagement
POSTs.
![Copper](https://merge-api-production.s3.amazonaws.com/media/PlatformCopper.jpg)
Supported POST Model Parameters
engagement_type
UUIDowner
UUIDremote_id
Stringsubject
String![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
Supported POST Model Parameters
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_id
Stringsubject
String![Pipedrive](https://merge-api-production.s3.amazonaws.com/media/PlatformPipedrive.jpg)
Supported POST Model Parameters
account
UUIDcontacts
Arrayengagement_type
UUIDowner
UUIDremote_fields
RemoteField[]remote_field_class
objectvalue
objectremote_id
Stringsubject
String![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
Supported POST Model Parameters
account
UUIDcontacts
Arraycontent
Stringengagement_type
UUIDowner
UUIDremote_id
Stringsubject
StringAdditional POST Parameters
remote_fields
Objectremote_field_class
Stringvalue
String![Vtiger](https://merge-api-production.s3.amazonaws.com/media/Platformvtiger_square.png)
Supported POST Model Parameters
account
UUIDcontent
Stringend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_id
Stringstart_time
DateTime (ISO 8601)subject
String![Zendesk Sell](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_8wt2TTW.png)
Supported POST Model Parameters
account
UUIDcontent
Stringdirection
Enumengagement_type
UUIDowner
UUIDremote_id
Stringstart_time
DateTime (ISO 8601)![Zoho CRM](https://merge-api-production.s3.amazonaws.com/media/Platformzohocrm_square.png)
Supported POST Model Parameters
account
UUIDcontent
Stringdirection
Enumend_time
DateTime (ISO 8601)engagement_type
UUIDowner
UUIDremote_id
Stringstart_time
DateTime (ISO 8601)subject
Stringhttps://api.merge.dev/api/crm/v1/engagements/remote-field-classes
Returns a list of RemoteFieldClass
objects.
cursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleanis_common_model_field
Booleanpage_size
Integer