POST

/accounts/{accountId}/users#operation=add

http://service.chime.aws.amazon.com/accounts/{accountId}/users#operation=add

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime <code>Team</code> account. Only <code>Team</code> account types are currently supported for this action.

Access Token Required: API Key

Path Parameters

accountIdstringrequired

The Amazon Chime account ID.

Query Params

operationstringrequired

Allowed:

Body Params

UserTypestring

The user type.

UserEmailListarrayrequired

The user email addresses to which to send the email invitation.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/accounts/{accountId}/users#operation=add' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}