v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

post/channels/{channelArn}/bans#x-amz-chime-bearer

Path parameters

channelArnstring required

The ARN of the ban request.

Headers

x-amz-chime-bearerstring required

The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.

Request body

MemberArnstring required

The <code>AppInstanceUserArn</code> of the member being banned.

Response

Success

ChannelArnstring

The ARN of the response to the ban request.