Engagement Types

The Engagement Type object is used to represent an interaction activity. A given Engagement typically has an Engagement Type object represented in the engagement_type field.

The EngagementType object

Properties


activity_typeEnum
Optional
The engagement type's activity type. Possible values include: CALL, MEETING, EMAIL, or - in cases where there is no clear mapping - the original value passed through.

nameString
Optional
The engagement type's name.

idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

remote_fieldsRemoteField[]
Required

The EngagementType object
JSON
{
"activity_type": "CALL",
"name": "First Call",
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
"remote_fields": [
{
"value": {}
}
]
}

GET

/engagement-types

Returns a list of EngagementType objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"activity_type": "CALL",
"name": "First Call",
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
"remote_fields": [
{
"value": {}
}
]
}
]
}
Field support by platform

Accelo

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Insightly

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Microsoft Dynamics 365 Sales

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Nutshell

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

SugarCRM

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Vtiger

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/engagement-types/{id}

Returns an EngagementType object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


idString
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.
Response
JSON
{
"activity_type": "CALL",
"name": "First Call",
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
"remote_fields": [
{
"value": {}
}
]
}
Field support by platform

Accelo

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Insightly

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Microsoft Dynamics 365 Sales

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Nutshell

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

SugarCRM

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Vtiger

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/engagement-types/remote-field-classes

CLOSED BETA

Returns a list of RemoteFieldClass objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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.

page_sizeInteger
Optional
Number of results to return per page.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"display_name": "string",
"remote_key_name": "string",
"description": "string",
"is_required": true,
"field_choices": [
"string"
],
"item_schema": {
"item_type": "string",
"item_format": "string",
"item_choices": [
"string"
]
},
"is_custom": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
Field support by platform

Accelo

Accelo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Insightly

Insightly

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Keap

Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Microsoft Dynamics 365 Sales

Microsoft Dynamics 365 Sales

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Nutshell

Nutshell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

SugarCRM

SugarCRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

remote_idString

Vtiger

Vtiger

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


activity_typeEnum

nameString
Hint: Use the /linked-accounts endpoint to pull platform support information.