v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14191644620.9 KB

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

put/channels/{channelArn}

Path parameters

channelArnstring required

The ARN of the channel.

Headers

x-amz-chime-bearerstring

The <code>AppInstanceUserArn</code> of the user that makes the API call.

Request body

Namestring password required

The name of the channel.

Mode'UNRESTRICTED' | 'RESTRICTED' required

The mode of the update request.

Metadatastring password

The metadata for the update request.

Response

Success

ChannelArnstring

The ARN of the channel.