CreateRoomMembership - Amazon Chime


Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. 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 HTTP/1.1 Content-type: application/json { "MemberId": "string", "Role": "string" }

URI Request Parameters

The request uses the following URI parameters.


The Amazon Chime account ID.

Pattern: .*\S.*

Required: Yes


The room ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.


The Amazon Chime member ID (user ID or bot ID).

Type: String

Pattern: .*\S.*

Required: Yes


The role of the member.

Type: String

Valid Values: Administrator | Member

Required: No

Response Syntax

HTTP/1.1 201 Content-type: application/json { "RoomMembership": { "InvitedBy": "string", "Member": { "AccountId": "string", "Email": "string", "FullName": "string", "MemberId": "string", "MemberType": "string" }, "Role": "string", "RoomId": "string", "UpdatedTimestamp": number } }

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.


The room membership details.

Type: RoomMembership object


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


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

HTTP Status Code: 400


The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409


The client is permanently forbidden from making the request.

HTTP Status Code: 403


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

HTTP Status Code: 404


The request exceeds the resource limit.

HTTP Status Code: 400


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


The client is not currently authorized to make the request.

HTTP Status Code: 401


In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.


This example adds the specified user to the chat room as a chat room member.

Sample Request

POST /accounts/12a3456b-7c89-012d-3456-78901e23fg45/rooms/abcd1e2d-3e45-6789-01f2-3g45h67i890j/memberships HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/1.16.293 Python/3.8.0 Windows/10 botocore/1.13.29 X-Amz-Date: 20191202T223641Z Authorization: AUTHPARAMS Content-Length: 52 {"MemberId": "1ab2345c-67de-8901-f23g-45h678901j2k"}

Sample Response

HTTP/1.1 201 Created x-amzn-RequestId: 899d868f-767e-45f7-b516-7066985c96ff Content-Type: application/json Content-Length: 381 Date: Mon, 02 Dec 2019 22:36:42 GMT Connection: keep-alive {"RoomMembership":{"InvitedBy":"arn:aws:iam::111122223333:user/alejandro","Member":{"AccountId":"12a3456b-7c89-012d-3456-78901e23fg45","Email":"","FullName":"Jane Doe","MemberId":"1ab2345c-67de-8901-f23g-45h678901j2k","MemberType":"User"},"Role":"Member","RoomId":"abcd1e2d-3e45-6789-01f2-3g45h67i890j","UpdatedTimestamp":"2019-12-02T22:36:41.969Z"}}

See Also

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