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 EngagementType object
          • GET/engagement-types
          • GET/engagement-types/{id}
          • GET/engagement-types/remote-field-classes
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsEngagement types

The Engagement Type Object

The EngagementType 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  "activity_type": "CALL",
7  "name": "string",
8  "remote_fields": [
9    {
10      "remote_field_class": {
11        "id": "string",
12        "display_name": "string",
13        "remote_key_name": "string",
14        "description": "string",
15        "is_custom": true,
16        "is_common_model_field": true,
17        "is_required": true,
18        "field_type": "string",
19        "field_format": "string",
20        "field_choices": [
21          "string"
22        ],
23        "item_schema": {
24          "item_type": "string",
25          "item_format": "string",
26          "item_choices": [
27            "string"
28          ]
29        }
30      },
31      "value": {
32        "string": {}
33      }
34    }
35  ]
36}
Was this page helpful?
Previous

/contacts/remote-field-classes

Next

/engagement-types

Built with

Description

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.

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.
activity_typeenum or nullOptional

The engagement type's activity type.

  • CALL - CALL
  • MEETING - MEETING
  • EMAIL - EMAIL
Allowed values:
namestring or nullOptional
The engagement type's name.
remote_fieldslist of objectsOptionalRead-only