Merge · Schema

Conversation

# The Conversation Object ### Description The `Conversation` object is used to represent a conversation within the Chat account. ### Usage Example Fetch from the `GET /api/chat/v1/conversations` endpoint and view their conversations.

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.
name	stringnull	The name of the conversation
description	stringnull	The description of the conversation.
url	stringnull	The url of the conversation.
type	object	The type of the conversation.
members	array
remote_created_at	stringnull	When the third party's conversation was created.
remote_updated_at	stringnull	When the third party's conversation was updated.
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

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Conversation",
  "title": "Conversation",
  "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."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of the conversation"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The description of the conversation."
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The url of the conversation."
    },
    "type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The type of the conversation."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's conversation was created."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's conversation was updated."
    },
    "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/ConversationFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The Conversation Object\n### Description\nThe `Conversation` object is used to represent a conversation within the Chat account.\n\n### Usage Example\nFetch from the `GET /api/chat/v1/conversations` endpoint and view their conversations."
}