Skip to main content
Version: v1

WorkspaceChatMembership

Information about a chat and its members

chat object

Chat information

chatIdstring
membershipIdsstring[]
workspaceIdstring
namestring
typeWorkspaceChatType (string)

Chat type (public, private, common, breakout)

Possible values: [PRIVATE, PUBLIC, GENERAL, BREAKOUT]

Example: PUBLIC
announceChannelboolean
descriptionstring
roleChatMemberRoleType (string)

Member role in a chat (member, admin, owner)

Possible values: [CHAT_MEMBER, CHAT_ADMIN, CHAT_OWNER]

Example: CHAT_MEMBER
permissionsChatPermission (string)[]

Possible values: [CHANGE_ROLE, ARCHIVE_CHAT, RENAME_CHAT, UPDATE_CONFIG, KICK_FROM_CHAT, SEND_MESSAGES_TO_ANNOUNCE_CHANNEL, PIN_CHAT_MESSAGE, SCHEDULE_CONFERENCE, DELETE_CHAT_MESSAGE, UPDATE_PERMISSIONS, FORWARD_MESSAGES]

WorkspaceChatMembership
{
"chat": {
"chatId": "c56Y0kgi",
"membershipIds": [
"a56Y0kgi",
"a56Y0kgi"
],
"workspaceId": "w67Y89gu",
"name": "Off-topic",
"type": "PUBLIC",
"announceChannel": true,
"description": "Conversations on any topics except work"
},
"role": "CHAT_MEMBER",
"permissions": [
"RENAME_CHAT"
]
}