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 Conversation object
          • GET/conversations
          • GET/conversations/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsConversations

The Conversation object

The Conversation 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  "name": "string",
7  "description": "string",
8  "url": "string",
9  "type": "PRIVATE_INTERNAL",
10  "members": [
11    "string"
12  ],
13  "remote_created_at": "2023-01-01T00:00:00Z",
14  "remote_updated_at": "2023-01-01T00:00:00Z",
15  "remote_was_deleted": true,
16  "field_mappings": {},
17  "remote_data": [
18    {
19      "path": "string",
20      "data": {}
21    }
22  ]
23}
Was this page helpful?
Previous

Versioning

Next

/conversations

Built with

The Conversation object is used to represent a conversation within the Chat account.

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.
namestring or nullOptional<=80 characters
The name of the conversation
descriptionstring or nullOptional
The description of the conversation.
urlstring or nullOptionalformat: "uri"<=2000 characters
The url of the conversation.
typeenum or nullOptional

The type of the conversation.

  • PRIVATE_INTERNAL - PRIVATE_INTERNAL
  • PRIVATE_EXTERNAL - PRIVATE_EXTERNAL
  • PUBLIC_INTERNAL - PUBLIC_INTERNAL
  • PUBLIC_EXTERNAL - PUBLIC_EXTERNAL
  • ONE_ON_ONE_CHAT - ONE_ON_ONE_CHAT
  • GROUP_CHAT - GROUP_CHAT
  • MEETING_CHAT - MEETING_CHAT
memberslist of stringsOptional
remote_created_atdatetime or nullOptional
When the third party's conversation was created.
remote_updated_atdatetime or nullOptional
When the third party's conversation was updated.
remote_was_deletedbooleanOptionalRead-only

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.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only