Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14191644620.9 KB

Adds a specified number of users to a channel.

post/channels/{channelArn}/memberships#operation=batch-create

Path parameters

channelArnstring required

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

Query parameters

operation'batch-create' required

Headers

x-amz-chime-bearerstring

The <code>AppInstanceUserArn</code> of the user 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.

Response

Success