Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Adds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can:

  • List messages

  • Send messages

  • Receive messages

  • Edit their own messages

  • Leave the channel

Privacy settings impact this action as follows:

  • Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

  • Private Channels: You must be a member to list or send messages.

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

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

Path parameters

channelArnstring required

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

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 you want to add to the channel.

Type'DEFAULT' | 'HIDDEN' required

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.

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

ChannelArnstring

The ARN of the channel.

SubChannelIdstring

The ID of the SubChannel in the response.