Merge · Schema

Engagement

# The Engagement Object ### Description The `Engagement` object is used to represent an interaction noted in a CRM system. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
id string
remote_id stringnull The third-party API ID of the matching object.
created_at string The datetime that this object was created by Merge.
modified_at string The datetime that this object was modified by Merge.
owner stringnull The engagement's owner.
content stringnull The engagement's content.
subject stringnull The engagement's subject.
direction object The engagement's direction.
engagement_type stringnull The engagement type of the engagement.
start_time stringnull The time at which the engagement started.
end_time stringnull The time at which the engagement ended.
account stringnull The account of the engagement.
contacts array
engagement_url stringnull The engagement's URL in the remote system.
remote_was_deleted boolean 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 cove
field_mappings object
remote_data arraynull
remote_fields array
View JSON Schema on GitHub

JSON Schema

merge-engagement-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Engagement",
  "title": "Engagement",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "owner": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The engagement's owner."
    },
    "content": {
      "type": [
        "string",
        "null"
      ],
      "description": "The engagement's content."
    },
    "subject": {
      "type": [
        "string",
        "null"
      ],
      "description": "The engagement's subject."
    },
    "direction": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/DirectionEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The engagement's direction."
    },
    "engagement_type": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The engagement type of the engagement."
    },
    "start_time": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The time at which the engagement started."
    },
    "end_time": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The time at which the engagement ended."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The account of the engagement."
    },
    "contacts": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "engagement_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The engagement's URL in the remote system."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/EngagementFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteField"
      }
    }
  },
  "description": "# The Engagement Object\n### Description\nThe `Engagement` object is used to represent an interaction noted in a CRM system.\n### Usage Example\nTODO"
}