MPIM object
A MPIM object is a legacy object that contains information about a multi-party instant message. MPIM objects are now conversation objects.
{
"id": "G024BE91L",
"name": "mpdm-user1--user2--user3-1",
"is_mpim": true,
"is_group": false,
"created": 1360782804,
"creator": "U024BE7LH",
"members": [
"U024BE7LH"
],
"last_read": "1401383885.000061",
"latest": {},
"unread_count": 0,
"unread_count_display": 0
}
MPIM object fields
| Field | Type | Description |
|---|---|---|
accepted_user | user_id | User who accepted a shared channel invite. |
connected_team_ids | Array of workspace_id | Externally connected team IDs (Slack Connect). |
context_team_id | team_id | Team/workspace ID context for this MPIM. Required field. |
conversation_host_id | team_id | Team ID of the conversation host. |
created | Unix timestamp | Indicates when the MPIM was created. |
creator | String | The user ID of the member that created the MPIM. |
display_counts | Object | Display and guest counts (display_counts, guest_counts). |
frozen_reason | String | Reason the MPIM was frozen. |
id | String | The ID of the MPIM. |
internal_team_ids | Array of workspace_id | Internal workspace IDs in this MPIM. |
is_archived | Boolean | Whether the MPIM is archived. Required field. |
is_channel | Boolean | Whether this is a channel. Required field. |
is_ext_shared | Boolean | Whether the MPIM is externally shared (Slack Connect). |
is_frozen | Boolean | Whether the MPIM is frozen. |
is_general | Boolean | Whether this is the #general channel. Required field. |
is_group | Boolean | Indicates if the object is a group. |
is_im | Boolean | Whether this is a 1:1 DM. Required field. |
is_member | Boolean | Whether the calling user is a member. |
is_moved | Integer | Whether the MPIM has been moved across workspaces. |
is_mpim | Boolean | Indicates if a multi-party instant message (mpim) is being emulated as a group. For compatibility with older clients, mpims can appear as groups unless rtm.start is called with mpim_aware=1. |
is_non_threadable | Boolean | Whether threading is disabled. |
is_open | Boolean | Whether the MPIM is open in the client. |
is_org_shared | Boolean | Whether the MPIM is shared across an organization. Required field. |
is_pending_ext_shared | Boolean | Whether the MPIM has a pending external share. |
is_private | Boolean | Whether the MPIM is private. Required field. |
is_read_only | Boolean | Whether the MPIM is read-only. |
is_shared | Boolean | Whether the MPIM is shared across workspaces. Required field. |
is_starred | Boolean | Whether the calling user has starred this MPIM. |
is_thread_only | Boolean | Whether only threaded messages are allowed. |
last_read | ts (String) | Message timestamp of the last read message. |
latest | Message object or null | The most recent message in the MPIM. |
members | Array | A list of user IDs for all users in this MPIM. This includes any disabled accounts that were in this MPIM when they were disabled. |
name | String | Indicates the name of the MPIM. |
name_normalized | String | Normalized version of the MPIM name. Required field. |
num_members | Integer or null | Total number of members. |
parent_conversation | channel_id or null | ID of the parent conversation, if any. |
pending_connected_team_ids | Array of workspace_id | Team IDs with pending Slack Connect invitations. |
pending_shared | Array of workspace_id | Workspace IDs with pending shares. |
pin_count | Integer | Number of pinned items. |
previous_names | Array of string | Previous names of the MPIM. |
priority | Number | Sort priority in the sidebar. |
purpose | Object | Purpose of the MPIM (value, creator, last_set). Required field. |
shared_team_ids | Array of workspace_id | Workspace IDs this MPIM is shared with. |
shares | Array of objects | Share details (each has team, user, is_active, optional accepted_user). |
target_user_id | String | Target user ID. |
timezone_count | Integer | Number of timezones across members. |
topic | Object | Topic of the MPIM (value, creator, last_set). Required field. |
unlinked | Integer | Whether the channel has ever been shared/disconnected in the past. |
unread_count | Integer | Full count of unread messages. |
unread_count_display | Integer | Count of unread messages that matter to the user. |
updated | Integer | Unix timestamp of when the MPIM was last updated. Required field. |
user | user_id | User ID (for DM-like contexts). |
version | Integer | Version number of the conversation object. |