Patch Channel

Partially update a channel. Only the fields provided are updated; omitted fields are left unchanged.

Required Permissions: manage_public_channel_members for public channels or manage_private_channel_members for private channels.

External Documentation

To learn more, visit the Mattermost documentation.

​

Basic Parameters

Parameter	Description
Channel ID	The ID of the channel. Can be obtained from the List All Channels action.
Display Name	The display name of the channel. Cannot be updated for direct or group message channels.
Name	The unique handle of the channel. Cannot be updated for direct or group message channels or the default channel.
Purpose	A short description of the channel’s purpose. Cannot be updated for direct or group message channels.

​

Advanced Parameters

Parameter	Description
Autotranslation	Select to enable automatic message translation in the channel. Requires the auto-translation feature and appropriate channel permission.
Banner Background Color	The HEX color code for the banner’s background.
Banner Enabled	Select to enable the channel banner.
Banner Text	The text to render in the channel banner. Supports Markdown format.
Default Category Name	The default sidebar category name for members when joining this channel. Set to an empty string to clear.
Group Constrained	Select to restrict channel membership to members of the linked LDAP groups. Only applicable to public and private channels.
Header	The markdown-formatted header text displayed above the post input in the channel.
Managed Category Name	The name of the managed category to assign this channel to. Set to an empty string to clear.

​

Example Output

{
	"id": "string",
	"create_at": -9007199254740991,
	"update_at": -9007199254740991,
	"delete_at": -9007199254740991,
	"team_id": "string",
	"type": "string",
	"display_name": "string",
	"name": "string",
	"header": "string",
	"purpose": "string",
	"last_post_at": -9007199254740991,
	"total_msg_count": 0,
	"extra_update_at": -9007199254740991,
	"creator_id": "string"
}