Skip to content

/AWS1/CL_CHS=>CREATECHANNELMEMBERSHIP()

About CreateChannelMembership

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.

Method Signature

IMPORTING

Required arguments:

IV_CHANNELARN TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

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

IV_MEMBERARN TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The AppInstanceUserArn of the member you want to add to the channel.

IV_TYPE TYPE /AWS1/CHSCHANNELMEMBERSHIPTYPE /AWS1/CHSCHANNELMEMBERSHIPTYPE

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

IV_CHIMEBEARER TYPE /AWS1/CHSCHIMEARN /AWS1/CHSCHIMEARN

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Optional arguments:

IV_SUBCHANNELID TYPE /AWS1/CHSSUBCHANNELID /AWS1/CHSSUBCHANNELID

The ID of the SubChannel in the request.

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CHSCRECHANNELMEMBER01 /AWS1/CL_CHSCRECHANNELMEMBER01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC