POST

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

http://service.chime.aws.amazon.com/channels/{channelArn}/memberships#operation=batch-create

Adds a specified number of users to a channel.

Access Token Required: API Key

Path Parameters

channelArnstringrequired

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

Query Params

operationstringrequired

Allowed:

Body Params

Typestring

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.

MemberArnsarrayrequired

The ARNs of the members you want to add to the channel.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/channels/{channelArn}/memberships#operation=batch-create' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}