For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Engagement object
          • GET/engagements
          • POST/engagements
          • GET/engagements/{id}
          • PATCH/engagements/{id}
          • GET/engagements/meta/patch/{id}
          • GET/engagements/meta/post
          • GET/engagements/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsEngagements

The Engagement object

The Engagement Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "owner": "string",
7  "content": "string",
8  "subject": "string",
9  "direction": "INBOUND",
10  "engagement_type": "string",
11  "start_time": "2023-01-01T00:00:00Z",
12  "end_time": "2023-01-01T00:00:00Z",
13  "account": "string",
14  "contacts": [
15    "string"
16  ],
17  "remote_was_deleted": true,
18  "field_mappings": {},
19  "remote_data": [
20    {
21      "path": "string",
22      "data": {}
23    }
24  ],
25  "remote_fields": [
26    {
27      "remote_field_class": {
28        "id": "string",
29        "display_name": "string",
30        "remote_key_name": "string",
31        "description": "string",
32        "is_custom": true,
33        "is_common_model_field": true,
34        "is_required": true,
35        "field_type": "string",
36        "field_format": "string",
37        "field_choices": [
38          "string"
39        ],
40        "item_schema": {
41          "item_type": "string",
42          "item_format": "string",
43          "item_choices": [
44            "string"
45          ]
46        }
47      },
48      "value": {
49        "string": {}
50      }
51    }
52  ]
53}
Was this page helpful?
Previous

/engagement-types/remote-field-classes

Next

/engagements

Built with

The Engagement object is used to represent an interaction noted in a CRM system.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
ownerstring or nullOptionalformat: "uuid"
The engagement's owner.
contentstring or nullOptional
The engagement's content.
subjectstring or nullOptional
The engagement's subject.
directionenum or nullOptional

The engagement's direction.

  • INBOUND - INBOUND
  • OUTBOUND - OUTBOUND
Allowed values:
engagement_typestring or nullOptionalformat: "uuid"
The engagement type of the engagement.
start_timedatetime or nullOptional
The time at which the engagement started.
end_timedatetime or nullOptional
The time at which the engagement ended.
accountstring or nullOptionalformat: "uuid"
The account of the engagement.
contactslist of stringsOptional
remote_was_deletedbooleanOptionalRead-only

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 or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only