channel resource type

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

Teams are made up of channels, which are the conversations you have with your teammates. Each channel is dedicated to a specific topic, department, or project. Channels are where the work actually gets done - where text, audio, and video conversations open to the whole team happen, where files are shared, and where tabs are added.

Methods

Method Return Type Description
List channels channel collection Get the list of channels in this team.
Create channel channel Create a new channel by including the display name and description.
Get channel channel Read properties and relationships of the channel.
Update channel channel Update properties of the channel.
Delete channel None Delete a channel.
List channel messages chatMessage Get messages in a channel
Create chatMessage in a channel chatMessage Send a message to a channel.
Create chatMessage reply in a channel chatMessage Reply to a message in a channel.
List tabs teamsTab Lists tabs pinned to a channel.
Get tab teamsTab Reads a tab pinned to a channel.
Add tab teamsTab Adds (pins) a tab to a channel.
Remove tab None Removes (unpins) a tab from a channel.
Update tab teamsTab Updates the tab properties.

Properties

Property Type Description
description String Optional textual description for the channel.
displayName String Channel name as it will appear to the user in Microsoft Teams.
id String The channels's unique identifier. Read-only.
isFavoriteByDefault Boolean Whether the channel should automatically be marked 'favorite' for all members of the team. Default: false.
email String The email address for sending messages to the channel. Read-only.
webUrl String A hyperlink that will navigate to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.

Relationships

Relationship Type Description
messages chatMessage collection A collection of all the messages in the channel. A navigation property. Nullable. Currently this API only supports reading but will eventually support writing messages too.
tabs teamsTab collection A collection of all the tabs in the channel. A navigation property.

JSON representation

Here is a JSON representation of the resource

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "isFavoriteByDefault": true,
  "email": "string",
  "webUrl": "string"
}