End of support notice: On February
20, 2026, AWS will end support for the Amazon Chime service. After February 20, 2026, you
will no longer be able to access the Amazon Chime console or Amazon Chime application resources. For
more information, visit the blog post
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 uses the following URI parameters.
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.
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 updates the settings for the specified user.
Sample Request
PUT /accounts/12a3456b-7c89-012d-3456-78901e23fg45/users/1ab2345c-67de-8901-f23g-45h678901j2k/settings HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20190918T181826Z Authorization: AUTHPARAMS Content-Length: 95 {"UserSettings": {"Telephony": {"InboundCalling": true, "OutboundCalling": true, "SMS": true}}}Sample Response
HTTP/1.1 204 No Content x-amzn-RequestId: 72ab9592-8aa8-4de1-9dd7-a8f84011261b Content-Type: application/json Date: Wed, 18 Sep 2019 18:18:27 GMT Connection: keep-alive See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
