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

InviteUsers

Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Request Syntax

POST /console/accounts/accountId/users?operation=add HTTP/1.1 Content-type: application/json { "UserEmailList": [ "string" ] }

URI Request Parameters

The request requires the following URI parameters.

AccountId

The Amazon Chime account ID.

Pattern: .*\S.*

Request Body

The request accepts the following data in JSON format.

UserEmailList

The user email addresses to which to send the invite.

Type: Array of strings

Array Members: Maximum number of 50 items.

Pattern: .+@.+\..+

Required: Yes

Response Syntax

HTTP/1.1 201 Content-type: application/json { "Invites": [ { "EmailAddress": "string", "EmailStatus": "string", "InviteId": "string", "Status": "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.

Invites

The invite details.

Type: Array of Invite 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

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

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: