Amazon Chime
API Reference (API Version 2018-05-01)

BatchCreateRoomMembership

Adds up to 50 members to a chat room. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

Request Syntax

POST /accounts/accountId/rooms/roomId/memberships?operation=batch-create HTTP/1.1 Content-type: application/json { "MembershipItemList": [ { "MemberId": "string", "Role": "string" } ] }

URI Request Parameters

The request requires the following URI parameters.

accountId

The Amazon Chime account ID.

Pattern: .*\S.*

roomId

The room ID.

Pattern: .*\S.*

Request Body

The request accepts the following data in JSON format.

MembershipItemList

The list of membership items.

Type: Array of MembershipItem objects

Array Members: Maximum number of 50 items.

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "MemberId": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Errors

If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.

Type: Array of MemberError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: