Patch channel

Namespace: microsoft.graph

Update the properties of the specified channel.

Note

When used with application permissions, this API is metered. It supports the model=A payment model. For details, see Payment models. If you don't specify a payment model in your query, the default evaluation mode will be used.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

This API supports admin permissions. Global admins and Microsoft Teams service admins can access teams that they aren't a member of.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) ChannelSettings.ReadWrite.All Directory.ReadWrite.All, Group.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application ChannelSettings.ReadWrite.Group ChannelSettings.ReadWrite.All, Directory.ReadWrite.All, Group.ReadWrite.All

Note

  • The ChannelSettings.ReadWrite.Group permission uses resource-specific consent.
  • The Group.ReadWrite.All and Directory.ReadWrite.All permissions are supported only for backward compatibility. We recommend that you update your solutions to use an alternative permission listed in the previous table and avoid using these permissions going forward.

HTTP request

PATCH /teams/{team-id}/channels/{channel-id}

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of channel object.

Note: You cannot update the membershipType value for an existing channel.

Response

If successful, this method returns a 204 No Content response code.

Example

Request

The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/teams/893075dd-2487-4122-925f-022c42e20265/channels/19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2

Response

The following example shows the response.

HTTP/1.1 204 No Content

Microsoft Graph service-specific throttling limits