Skip to main content

IM object

An IM object is a legacy object that contains information about a direct message channel. IM objects are now conversation objects.

{
"id": "D024BFF1M",
"is_im": true,
"user": "U024BE7LH",
"created": 1360782804,
"is_user_deleted": false
}

IM object fields

FieldTypeDescription
connected_team_idsArray of team_idTeam IDs of externally connected teams (Slack Connect).
context_team_idworkspace_id (String)The team/workspace ID context for this DM. Required field.
createdUnix timestampWhen the IM was created.
frozen_reasonStringReason the DM was frozen.
has_barrierBooleanWhether an information barrier applies to this DM.
has_pinsBooleanWhether the DM has any pinned items.
idStringThe ID of the object.
internal_team_idsArray of workspace_idWorkspace IDs of internal teams in the DM.
is_archivedBooleanWhether the DM is archived. Required field.
is_ext_sharedBooleanWhether the DM is externally shared (Slack Connect).
is_frozenBooleanWhether the DM is frozen.
is_imBooleanIndicates if the object is an IM.
is_migratingBooleanWhether the DM is currently being migrated.
is_openBooleanWhether the DM is open in the client.
is_org_sharedBooleanWhether the DM is shared across an organization. Required field.
is_pending_ext_sharedBooleanWhether the DM has a pending external share.
is_sharedBooleanWhether the DM is shared across workspaces.
is_starredBooleanWhether the calling user has starred this DM.
is_user_deletedBooleantrue if the other user's account has been disabled.
last_readts (String)Message timestamp of the last read message.
latestMessage objectThe most recent message in the DM.
localeStringLocale setting for the DM.
membersArray of user_idUser IDs of DM members.
pending_connected_team_idsArray of workspace_idTeam IDs with pending Slack Connect invitations.
pin_countIntegerNumber of pinned items.
priorityNumberSort priority for the DM in the sidebar.
propertiesObjectChannel properties associated with this DM.
purposeObjectPurpose of the DM (value, creator, last_set).
shared_team_idsArray of workspace_idAll workspace IDs this DM is shared with.
target_user_idStringUser ID of the other participant in the DM.
topicObjectTopic of the DM (value, creator, last_set).
unread_countIntegerFull count of unread messages.
unread_count_displayIntegerCount of unread messages that matter to the user.
updatedIntegerUnix timestamp of when the DM was last updated.
userStringEach direct message channel is between two users. One of these users is always the calling user, the other's ID is indicated by the user property.