microsoft.graph.channel

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.channel",
  "title": "microsoft.graph.channel",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.entity"
    },
    {
      "title": "channel",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "createdDateTime": {
          "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
          "type": "string",
          "description": "Read only. Timestamp at which the channel was created.",
          "format": "date-time",
          "nullable": true
        },
        "description": {
          "type": "string",
          "description": "Optional textual description for the channel.",
          "nullable": true
        },
        "displayName": {
          "type": "string",
          "description": "Channel name as it will appear to the user in Microsoft Teams. The maximum length is 50 characters."
        },
        "email": {
          "type": "string",
          "description": "The email address for sending messages to the channel. Read-only.",
          "nullable": true
        },
        "isArchived": {
          "type": "boolean",
          "description": "Indicates whether the channel is archived. Read-only.",
          "nullable": true
        },
        "isFavoriteByDefault": {
          "type": "boolean",
          "description": "Indicates whether the channel should be marked as recommended for all members of the team to show in their channel list. Note: All recommended channels automatically show in the channels list for education and frontline worker users. The property can only be set programmatically via the Create team method. The default value is false.",
          "nullable": true
        },
        "membershipType": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.channelMembershipType"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "The type of the channel. Can be set during creation and can't be changed. The possible values are: standard, private, unknownFutureValue, shared. The default value is standard. Use the Prefer: include-unknown-enum-members request header to get the following members in this evolvable enum: shared."
        },
        "summary": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.channelSummary"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Contains summary information about the channel, including number of owners, members, guests, and an indicator for members from other tenants. The summary property will only be returned if it is specified in the $select clause of the Get channel method."
        },
        "tenantId": {
          "type": "string",
          "description": "The ID of the Microsoft Entra tenant.",
          "nullable": true
        },
        "webUrl": {
          "type": "string",
          "description": "A hyperlink that will go 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.",
          "nullable": true
        },
        "allMembers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.conversationMember"
          },
          "description": "A collection of membership records associated with the channel, including both direct and indirect members of shared channels.",
          "x-ms-navigationProperty": true
        },
        "filesFolder": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.driveItem"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Metadata for the location where the channel's files are stored.",
          "x-ms-navigationProperty": true
        },
        "members": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.conversationMember"
          },
          "description": "A collection of membership records associated with the channel.",
          "x-ms-navigationProperty": true
        },
        "messages": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.chatMessage"
          },
          "description": "A collection of all the messages in the channel. A navigation property. Nullable.",
          "x-ms-navigationProperty": true
        },
        "sharedWithTeams": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.sharedWithChannelTeamInfo"
          },
          "description": "A collection of teams with which a channel is shared.",
          "x-ms-navigationProperty": true
        },
        "tabs": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.teamsTab"
          },
          "description": "A collection of all the tabs in the channel. A navigation property.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.channel"
}