Skip to main content

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

FieldTypeDescription
accepted_useruser_idUser who accepted a shared channel invite.
connected_team_idsArray of workspace_idExternally connected team IDs (Slack Connect).
context_team_idteam_idTeam/workspace ID context for this MPIM. Required field.
conversation_host_idteam_idTeam ID of the conversation host.
createdUnix timestampIndicates when the MPIM was created.
creatorStringThe user ID of the member that created the MPIM.
display_countsObjectDisplay and guest counts (display_counts, guest_counts).
frozen_reasonStringReason the MPIM was frozen.
idStringThe ID of the MPIM.
internal_team_idsArray of workspace_idInternal workspace IDs in this MPIM.
is_archivedBooleanWhether the MPIM is archived. Required field.
is_channelBooleanWhether this is a channel. Required field.
is_ext_sharedBooleanWhether the MPIM is externally shared (Slack Connect).
is_frozenBooleanWhether the MPIM is frozen.
is_generalBooleanWhether this is the #general channel. Required field.
is_groupBooleanIndicates if the object is a group.
is_imBooleanWhether this is a 1:1 DM. Required field.
is_memberBooleanWhether the calling user is a member.
is_movedIntegerWhether the MPIM has been moved across workspaces.
is_mpimBooleanIndicates 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_threadableBooleanWhether threading is disabled.
is_openBooleanWhether the MPIM is open in the client.
is_org_sharedBooleanWhether the MPIM is shared across an organization. Required field.
is_pending_ext_sharedBooleanWhether the MPIM has a pending external share.
is_privateBooleanWhether the MPIM is private. Required field.
is_read_onlyBooleanWhether the MPIM is read-only.
is_sharedBooleanWhether the MPIM is shared across workspaces. Required field.
is_starredBooleanWhether the calling user has starred this MPIM.
is_thread_onlyBooleanWhether only threaded messages are allowed.
last_readts (String)Message timestamp of the last read message.
latestMessage object or nullThe most recent message in the MPIM.
membersArrayA list of user IDs for all users in this MPIM. This includes any disabled accounts that were in this MPIM when they were disabled.
nameStringIndicates the name of the MPIM.
name_normalizedStringNormalized version of the MPIM name. Required field.
num_membersInteger or nullTotal number of members.
parent_conversationchannel_id or nullID of the parent conversation, if any.
pending_connected_team_idsArray of workspace_idTeam IDs with pending Slack Connect invitations.
pending_sharedArray of workspace_idWorkspace IDs with pending shares.
pin_countIntegerNumber of pinned items.
previous_namesArray of stringPrevious names of the MPIM.
priorityNumberSort priority in the sidebar.
purposeObjectPurpose of the MPIM (value, creator, last_set). Required field.
shared_team_idsArray of workspace_idWorkspace IDs this MPIM is shared with.
sharesArray of objectsShare details (each has team, user, is_active, optional accepted_user).
target_user_idStringTarget user ID.
timezone_countIntegerNumber of timezones across members.
topicObjectTopic of the MPIM (value, creator, last_set). Required field.
unlinkedIntegerWhether the channel has ever been shared/disconnected in the past.
unread_countIntegerFull count of unread messages.
unread_count_displayIntegerCount of unread messages that matter to the user.
updatedIntegerUnix timestamp of when the MPIM was last updated. Required field.
useruser_idUser ID (for DM-like contexts).
versionIntegerVersion number of the conversation object.