Engagements

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

The Engagement object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
ownerString
Optional
contentString
Optional
The engagement's content.
subjectString
Optional
The engagement's subject.
directionEnum
Optional
The engagement's direction. Possible values include: INBOUND, OUTBOUND, or - in cases where there is no clear mapping - the original value passed through.
engagement_typeString
Optional
start_timeString
Optional
The time at which the engagement started.
end_timeString
Optional
The time at which the engagement ended.
accountString
Optional
remote_dataRemoteData[]
Optional
remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.
The Engagement object
JSON
{
  "id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
  "remote_id": "19202938",
  "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "content": "Call for negotiation",
  "subject": "Call from customer",
  "direction": "INBOUND",
  "engagement_type": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "start_time": "2022-02-10T00:00:00Z",
  "end_time": "2022-02-10T00:05:00Z",
  "account": "025fjlc6-6000-430a-848e-aafacbadf4fe",
  "remote_data": [
    {
      "path": "/engagements",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}
GET

/engagements

Returns a list of Engagement 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.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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",
      "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
      "content": "Call for negotiation",
      "subject": "Call from customer",
      "direction": "INBOUND",
      "engagement_type": "0358cbc6-2040-430a-848e-aafacbadf3aa",
      "start_time": "2022-02-10T00:00:00Z",
      "end_time": "2022-02-10T00:05:00Z",
      "account": "025fjlc6-6000-430a-848e-aafacbadf4fe",
      "remote_data": [
        {
          "path": "/engagements",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true
    }
  ]
}
Field support by platform

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

contentString
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString
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.
POST

/engagements

Creates an Engagement object with the given values.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

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

remote_idString
Optional
The third-party API ID of the matching object.
ownerString
Optional
Must pass in a valid Merge ID, which can be obtained from the id field in the Owner table.
contentString
Optional
The engagement's content.
subjectString
Optional
The engagement's subject.
directionEnum
Optional
The engagement's direction. Must pass in one of the following choices: INBOUND, OUTBOUND.
engagement_typeString
Optional
Must pass in a valid Merge ID, which can be obtained from the id field in the Engagement_type table.
start_timeString
Optional
The time at which the engagement started.
end_timeString
Optional
The time at which the engagement ended.
accountString
Optional
Must pass in a valid Merge ID, which can be obtained from the id field in the Account table.
integration_paramsObject
Optional
linked_account_paramsObject
Optional
Response
JSON
{
  "model": {
    "id": "03455bc6-6040-430a-848e-aafacbfdf4fg",
    "remote_id": "19202938",
    "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
    "content": "Call for negotiation",
    "subject": "Call from customer",
    "direction": "INBOUND",
    "engagement_type": "0358cbc6-2040-430a-848e-aafacbadf3aa",
    "start_time": "2022-02-10T00:00:00Z",
    "end_time": "2022-02-10T00:05:00Z",
    "account": "025fjlc6-6000-430a-848e-aafacbadf4fe",
    "remote_data": [
      {
        "path": "/engagements",
        "data": [
          "Varies by platform"
        ]
      }
    ],
    "remote_was_deleted": true
  },
  "warnings": [
    {
      "source": {
        "pointer": "/age"
      },
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD"
    }
  ],
  "errors": [
    {
      "source": {
        "pointer": "/model/custom_fields"
      },
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD"
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "https://harvest.greenhouse.io/v1/candidates/",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}
Field support by platform

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

engagement_typeString
Optional
ownerString
Optional
remote_idString
Optional
subjectString
Optional

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

accountString
Optional
contentString
Optional
directionEnum
Optional
engagement_typeString
Required
ownerString
Optional
remote_idString
Optional
subjectString
Optional

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

accountString
Optional
engagement_typeString
Optional
ownerString
Optional
remote_idString
Optional
subjectString
Optional

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

accountString
Optional
contentString
Optional
directionEnum
Optional
engagement_typeString
Optional
ownerString
Optional
remote_idString
Optional
start_timeString
Optional

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

accountString
Optional
contentString
Optional
directionEnum
Optional
end_timeString
Optional
engagement_typeString
Optional
ownerString
Optional
remote_idString
Optional
start_timeString
Optional
subjectString
Optional
Salesforce

Salesforce

Coming Soon
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

/engagements/{id}

Returns an Engagement 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

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
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",
  "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "content": "Call for negotiation",
  "subject": "Call from customer",
  "direction": "INBOUND",
  "engagement_type": "0358cbc6-2040-430a-848e-aafacbadf3aa",
  "start_time": "2022-02-10T00:00:00Z",
  "end_time": "2022-02-10T00:05:00Z",
  "account": "025fjlc6-6000-430a-848e-aafacbadf4fe",
  "remote_data": [
    {
      "path": "/engagements",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}
Field support by platform

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

contentString
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString
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

/engagements/meta/post

Returns metadata for Engagement POSTs.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
  "request_schema": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}
Field support by platform

ActiveCampaign

ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Capsule

Capsule

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString

Close

Close

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Copper

Copper

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

HubSpot

HubSpot

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Pipedrive

Pipedrive

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Salesflare

Salesflare

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Salesforce

Salesforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
subjectString

Teamleader

Teamleader

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

contentString
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Teamwork CRM

Teamwork CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

contentString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString

Zendesk Sell

Zendesk Sell

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString

Zoho CRM

Zoho CRM

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

accountString
contentString
directionEnum
end_timeString
engagement_typeString
ownerString
remote_dataRemoteData[]
remote_idString
start_timeString
subjectString
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

Engagement Types

Next Up

Leads