Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Adds a specified number of users and bots to a channel.

post/channels/{channelArn}/memberships#operation=batch-create&x-amz-chime-bearer

Path parameters

channelArnstring required

The ARN of the channel to which you're adding users or bots.

Query parameters

operation'batch-create' required

Headers

x-amz-chime-bearerstring required

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

Request body

Type'DEFAULT' | 'HIDDEN'

The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.

MemberArnsChimeArn[] required

The ARNs of the members you want to add to the channel. Only <code>AppInstanceUsers</code> and <code>AppInstanceBots</code> can be added as a channel member.

SubChannelIdstring
<p>The ID of the SubChannel in the request. </p> <note> <p>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</p> </note>

Response

Success