Merge · Schema

Message

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

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.
user_id	stringnull	The user that sent the message.
conversation_id	stringnull	The conversation this message belongs to.
body	stringnull	The body of the message.
subject_line	stringnull	The subject line of the message.
root_message_id	stringnull	The root message this message belongs to.
url	stringnull	The url of the message.
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

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Message",
  "title": "Message",
  "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."
    },
    "user_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The user that sent the message."
    },
    "conversation_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The conversation this message belongs to."
    },
    "body": {
      "type": [
        "string",
        "null"
      ],
      "description": "The body of the message."
    },
    "subject_line": {
      "type": [
        "string",
        "null"
      ],
      "description": "The subject line of the message."
    },
    "root_message_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The root message this message belongs to."
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The url of the message."
    },
    "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/)."
    }
  },
  "description": "# The Message Object\n### Description\nThe `Message` object is used to represent a message within the Chat account.\n### Usage Example\nFetch from the `GET /api/chat/v1/messages` endpoint and view their message."
}