Skip to main content
Version: v2

ChatMetadata

Contains chat-type-specific information. One of the fields is populated depending on the chat type

personal object

Contains information about the personal chat

otherMembershipIdstringrequired

MembershipId of the other party

Example: aIQffAsGia
workspace object

Information about the workspace chat

namestringrequired

Chat name

Example: News
announcebooleanrequired

Whether the chat is an announcement chat

Example: true
chatTypeWorkspaceChatType (string)required

Chat type

Possible values: [PRIVATE, PUBLIC, GENERAL]

Example: PUBLIC
autoJoinNewMembersbooleanrequired

Whether new workspace members are automatically added to the chat

Example: true
descriptionstring

Chat description

Example: Company news
memberCountintegerrequired

Number of members

Example: 5
thread object

Thread information

parentChatIdstringrequired

ChatId of the parent chat where the parent message is located

Example: w:aIQffAsGia
parentMessageIdstringrequired

MessageId of the parent message the thread belongs to

Example: bIQffAsGia
conference object

Conference chat information

conferenceIdstringrequired

Identifier of the conference the chat relates to

Example: dIQffAsGia
userEvents object

Information about the chat with personal notifications

ownerstringrequired

MembershipId of the owner

Example: aIQffAsGia
ChatMetadata
{
"personal": {
"otherMembershipId": "aIQffAsGia"
},
"workspace": {
"name": "News",
"announce": "true",
"chatType": "PUBLIC",
"autoJoinNewMembers": "true",
"description": "Company news",
"memberCount": "5"
},
"thread": {
"parentChatId": "w:aIQffAsGia",
"parentMessageId": "bIQffAsGia"
},
"conference": {
"conferenceId": "dIQffAsGia"
},
"userEvents": {
"owner": "aIQffAsGia"
}
}