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

CreateRoomMembership

Adds a member to a chat room. 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 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.

MemberId

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

Type: String

Pattern: .*\S.*

Required: Yes

Role

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.

RoomMembership

The room membership details.

Type: RoomMembership object

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

ConflictException

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

HTTP Status Code: 409

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

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

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: