Sign in
channels

Patch a channel

Partially update a channel by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

Permissions

If updating a public channel, manage_public_channel_members permission is required. If updating a private channel, manage_private_channel_members permission is required.

put/api/v4/channels/{channel_id}/patch

Path parameters

channel_idstring required

Channel GUID

Request body

namestring

The unique handle for the channel, will be present in the channel URL

display_namestring

The non-unique UI name for the channel

purposestring

A short description of the purpose of the channel

headerstring

Markdown-formatted text to display in the header of the channel

Response

Channel patch successful

idstring
create_atinteger

The time in milliseconds a channel was created

update_atinteger

The time in milliseconds a channel was last updated

delete_atinteger

The time in milliseconds a channel was deleted

team_idstring
typestring
display_namestring
namestring
headerstring
purposestring
last_post_atinteger

The time in milliseconds of the last post of a channel

total_msg_countinteger
creator_idstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.