--- title: "PATCH /v4/users/{usersId}/settings" method: PATCH path: "/v4/users/{usersId}/settings" tags: ["users"] --- # PATCH /v4/users/{usersId}/settings `PATCH /v4/users/{usersId}/settings` ## Request - Base URL: `https://health.googleapis.com` - URL: `https://health.googleapis.com/v4/users/{usersId}/settings` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/googlehealth.settings.writeonly` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/googlehealth.settings.writeonly` Updates the user's settings details. ## Path parameters - `usersId` string, required ## Query parameters - `updateMask` string, google-fieldmask ## Request body - Settings: Settings details. - `autoStrideEnabled` boolean: Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported. - `distanceUnit` 'DISTANCE_UNIT_UNSPECIFIED' | 'DISTANCE_UNIT_MILES' | 'DISTANCE_UNIT_KILOMETERS': Optional. The measurement unit defined in the user's account settings. - `foodLanguageCode` string: Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported. - `glucoseUnit` 'GLUCOSE_UNIT_UNSPECIFIED' | 'GLUCOSE_UNIT_MG_DL' | 'GLUCOSE_UNIT_MMOL_L': Optional. The measurement unit defined in the user's account settings. - `heightUnit` 'HEIGHT_UNIT_UNSPECIFIED' | 'HEIGHT_UNIT_INCHES' | 'HEIGHT_UNIT_CENTIMETERS': Optional. The measurement unit defined in the user's account settings. - `languageLocale` string: Optional. The locale defined in the user's account settings. Updates to this field are currently not supported. - `name` string: Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. This field is read-only. - `strideLengthRunningType` 'STRIDE_LENGTH_TYPE_UNSPECIFIED' | 'STRIDE_LENGTH_TYPE_DEFAULT' | 'STRIDE_LENGTH_TYPE_MANUAL' | 'STRIDE_LENGTH_TYPE_AUTO': Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported. - `strideLengthWalkingType` 'STRIDE_LENGTH_TYPE_UNSPECIFIED' | 'STRIDE_LENGTH_TYPE_DEFAULT' | 'STRIDE_LENGTH_TYPE_MANUAL' | 'STRIDE_LENGTH_TYPE_AUTO': Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported. - `swimUnit` 'SWIM_UNIT_UNSPECIFIED' | 'SWIM_UNIT_METERS' | 'SWIM_UNIT_YARDS': Optional. The measurement unit defined in the user's account settings. - `temperatureUnit` 'TEMPERATURE_UNIT_UNSPECIFIED' | 'TEMPERATURE_UNIT_CELSIUS' | 'TEMPERATURE_UNIT_FAHRENHEIT': Optional. The measurement unit defined in the user's account settings. - `timeZone` string: Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported. - `utcOffset` string, google-duration: Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported. - `waterUnit` 'WATER_UNIT_UNSPECIFIED' | 'WATER_UNIT_ML' | 'WATER_UNIT_FL_OZ' | 'WATER_UNIT_CUP': Optional. The measurement unit defined in the user's account settings. - `weightUnit` 'WEIGHT_UNIT_UNSPECIFIED' | 'WEIGHT_UNIT_POUNDS' | 'WEIGHT_UNIT_STONE' | 'WEIGHT_UNIT_KILOGRAMS': Optional. The measurement unit defined in the user's account settings. ## Response `200` Successful response - Settings: Settings details. - `autoStrideEnabled` boolean: Optional. True if the user's stride length is determined automatically. Updates to this field are currently not supported. - `distanceUnit` 'DISTANCE_UNIT_UNSPECIFIED' | 'DISTANCE_UNIT_MILES' | 'DISTANCE_UNIT_KILOMETERS': Optional. The measurement unit defined in the user's account settings. - `foodLanguageCode` string: Output only. The food language code derived from the user's food database. Possible values: `'en-US'`, `'en-GB'`, `'de-DE'`, `'es-ES'`, `'fr-FR'`, `'zh-CN'`, `'zh-TW'`, `'ja-JP'`, `'en-AU'`, `'en-CA'`, `'it-IT'`, `'ko-KR'`, `'es-MX'`, `'en-IN'`, `'en-SG'`, `'en-PH'`, `'en-IE'`, `'fr-CA'`. Updates to this field are currently not supported. - `glucoseUnit` 'GLUCOSE_UNIT_UNSPECIFIED' | 'GLUCOSE_UNIT_MG_DL' | 'GLUCOSE_UNIT_MMOL_L': Optional. The measurement unit defined in the user's account settings. - `heightUnit` 'HEIGHT_UNIT_UNSPECIFIED' | 'HEIGHT_UNIT_INCHES' | 'HEIGHT_UNIT_CENTIMETERS': Optional. The measurement unit defined in the user's account settings. - `languageLocale` string: Optional. The locale defined in the user's account settings. Updates to this field are currently not supported. - `name` string: Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user. This field is read-only. - `strideLengthRunningType` 'STRIDE_LENGTH_TYPE_UNSPECIFIED' | 'STRIDE_LENGTH_TYPE_DEFAULT' | 'STRIDE_LENGTH_TYPE_MANUAL' | 'STRIDE_LENGTH_TYPE_AUTO': Optional. The stride length type defined in the user's account settings for running. Updates to this field are currently not supported. - `strideLengthWalkingType` 'STRIDE_LENGTH_TYPE_UNSPECIFIED' | 'STRIDE_LENGTH_TYPE_DEFAULT' | 'STRIDE_LENGTH_TYPE_MANUAL' | 'STRIDE_LENGTH_TYPE_AUTO': Optional. The stride length type defined in the user's account settings for walking. Updates to this field are currently not supported. - `swimUnit` 'SWIM_UNIT_UNSPECIFIED' | 'SWIM_UNIT_METERS' | 'SWIM_UNIT_YARDS': Optional. The measurement unit defined in the user's account settings. - `temperatureUnit` 'TEMPERATURE_UNIT_UNSPECIFIED' | 'TEMPERATURE_UNIT_CELSIUS' | 'TEMPERATURE_UNIT_FAHRENHEIT': Optional. The measurement unit defined in the user's account settings. - `timeZone` string: Optional. The timezone defined in the user's account settings. This follows the IANA [Time Zone Database](https://www.iana.org/time-zones). Updates to this field are currently not supported. - `utcOffset` string, google-duration: Optional. The user's timezone offset relative to UTC. Updates to this field are currently not supported. - `waterUnit` 'WATER_UNIT_UNSPECIFIED' | 'WATER_UNIT_ML' | 'WATER_UNIT_FL_OZ' | 'WATER_UNIT_CUP': Optional. The measurement unit defined in the user's account settings. - `weightUnit` 'WEIGHT_UNIT_UNSPECIFIED' | 'WEIGHT_UNIT_POUNDS' | 'WEIGHT_UNIT_STONE' | 'WEIGHT_UNIT_KILOGRAMS': Optional. The measurement unit defined in the user's account settings. --- [API](https://skmtc.dev/google/apis/health.md) - [All operations](https://skmtc.dev/google/apis/health/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/health/revisions/e0bfc8d98a6f?raw)