The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
InviteUsers
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime
Team
account. Only Team
account types are currently
supported for this action.
Request Syntax
POST /accounts/accountId
/users?operation=add HTTP/1.1
Content-type: application/json
{
"UserEmailList": [ "string
" ],
"UserType": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- accountId
-
The Amazon Chime account ID.
Pattern:
.*\S.*
Required: Yes
Request Body
The request accepts the following data in JSON format.
- UserEmailList
-
The user email addresses to which to send the email invitation.
Type: Array of strings
Array Members: Maximum number of 50 items.
Pattern:
.+@.+\..+
Required: Yes
- UserType
-
The user type.
Type: String
Valid Values:
PrivateUser | SharedDevice
Required: No
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.
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.
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
Examples
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)
Example
This example sends an email to invite users to the specified account.
Sample Request
POST /console/accounts/12a3456b-7c89-012d-3456-78901e23fg45/users?operation=add HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.83 Python/3.6.6 Windows/10 botocore/1.12.73 X-Amz-Date: 20190108T180827Z Authorization: AUTHPARAMS Content-Length: 46 {"UserEmailList": ["user1@example.com", "user2@example.com"]}
Sample Response
HTTP/1.1 201 Created x-amzn-RequestId: e1b2ea98-2934-400d-a5f1-f68d74658ea6 Content-Type: application/json Content-Length: 204 Date: Tue, 08 Jan 2019 18:08:27 GMT Connection: keep-alive {"Invites": [{"EmailAddress": "user1@example.com","EmailStatus": "Sent","InviteId": "a12bc345-6def-78g9-01h2-34jk56789012","Status": "Pending",}{"EmailAddress": "user2@example.com","EmailStatus": "Sent","InviteId": "b12bc345-6def-78g9-01h2-34jk56789012","Status": "Pending",}] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: