Create Channel

Create a Microsoft Teams channel.

Input

Field Definition Type Required
Team      
ID Unique ID of the team. String TRUE
Channel      
Display Name Display name of the channel. Maximum limit of 50 characters. String TRUE
Description Description for the channel. String FALSE
Is Favorite By Default If True, indicates whether the channel should automatically be marked favorite for all members of the team. Boolean FALSE
Membership Type Type of the channel. Possible values are:
  • Standard - Channel inherits the list of all members of the parent team.

  • Private - Channel can have members that are a subset of all the members on the parent team. Limit of 30 private channels per team.

  • Members can only be added to private channels.

  • Members can only be removed from private channels.

Dropdown TRUE
User IDs Unique identifier for the user.
  • Users can only be added to private channels.

  • Users can only be removed from private channels.

List of Strings TRUE

For membership type, when creating a private channel, the entire team is added as members of the channel. After a delay, the user who created the Workflows connection is assigned as an owner of the channel.

Output

Field Definition Type
ID Unique ID of the channel. String
Display Name Display name of the channel. String
Description Description for the channel. String
Email Email address for sending messages to the channel. String
Is Favorite By Default Specifies whether the channel should automatically be marked favorite for all members of the team. Boolean
Web URL Hyperlink that will go to the team in the Microsoft Teams client. This is the URL that you get when you right-click a team in the Microsoft Teams client and select Get link to team. String
Membership Type Specifies the type of the channel. Possible values are Standard and Private. String
Created Date Time Date and time that the channel was created. Date and Time
Status Code Result of the operation. The HTTP status code is returned by the connector and indicates whether the action taken by the card succeeded or failed. For example:
  • A 201 Created status code indicates success where a new resource was created.
  • A 403 Forbidden error indicates that the HTTP request was not processed because the necessary permissions were missing.

For a full list of possible status codes, see HTTP status codes.

Number

Additional information

  • Add users to private channels only.

  • All users who have been added to a private channels must already be a member of the Team.

  • Users previously added to private channels can only be removed from private channels.

  • All User IDs passed into the card are made owners of the private channel.

  • The user account used to created the Workflows connection is automatically be added to the list of users by the connector. It is not necessary to pass in the user ID for the connected user.

Related topics

Microsoft Teams connector

About the elements of Okta Workflows

Microsoft Teams API overview