Merge · Schema

EngagementRequest

# 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
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.
integration_params objectnull
linked_account_params objectnull
remote_fields array
View JSON Schema on GitHub

JSON Schema

merge-engagementrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EngagementRequest",
  "title": "EngagementRequest",
  "type": "object",
  "properties": {
    "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."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The Engagement Object\n### Description\nThe `Engagement` object is used to represent an interaction noted in a CRM system.\n### Usage Example\nTODO"
}