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

UpdateUserSettings

Updates the settings for the specified user, such as phone number settings.

Request Syntax

PUT /accounts/accountId/users/userId/settings HTTP/1.1 Content-type: application/json { "UserSettings": { "Telephony": { "InboundCalling": boolean, "OutboundCalling": boolean, "SMS": boolean } } }

URI Request Parameters

The request requires the following URI parameters.

AccountId

The Amazon Chime account ID.

UserId

The user ID.

Request Body

The request accepts the following data in JSON format.

UserSettings

The user settings to update.

Type: UserSettings object

Required: Yes

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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: