Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Creates a channel to which you can add users and send messages.

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

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#x-amz-chime-bearer

Headers

x-amz-chime-bearerstring required

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

Request body

AppInstanceArnstring required

The ARN of the channel request.

Namestring password required

The name of the channel.

Mode'UNRESTRICTED' | 'RESTRICTED'

The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

Privacy'PUBLIC' | 'PRIVATE'

The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the <code>AppInstance</code>.

Metadatastring password

The metadata of the creation request. Limited to 1KB and UTF-8.

ClientRequestTokenstring password required

The client token for the request. An <code>Idempotency</code> token.

ChannelIdstring password

An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.

MemberArnsChimeArn[]

The ARNs of the channel members in the request.

ModeratorArnsChimeArn[]

The ARNs of the channel moderators in the request.

Response

Success

ChannelArnstring

The ARN of the channel.