Engagement Types

The Engagement Type object is used to represent the type of an engagement in the remote system.

The EngagementType object

Properties


idString
Required

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

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.

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

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.

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

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

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

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

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
Not seeing a platform that you're looking for? Submit a request for it here.
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.
Response
JSON
{
"id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
"remote_id": "19202938",
"activity_type": "CALL",
"name": "First Call"
}
Field support by platform

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

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

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

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
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Contacts