🟢 Enable features
This endpoint allows you to activate a feature on a device.
Endpoint Overview:
- Endpoint:
https://wbsapi.withings.net/v2/device
- Method:
POST
Parameters
To activate a feature, your API call must include:
action
: Must take the valueenablefeature
.client_id
: Your unique identifier provided by Withings.signature
: Your request signature for authentication.nonce
: A unique, random number for request validation.feature_name
: The name of the feature you wish to activate.userid
: The user ID associated with the device.model
: The model of the device, e.g., "Body Pro 2".
Available Features
Here's a table of features that can be activated through the API:
Feature Name | Description | Compatible Model | Activated by Default |
---|---|---|---|
feature_muscle_mass | Measures muscle mass. | Body Pro 2 (model: 17) | ✅ |
feature_fat_mass | Measures fat mass. | Body Pro 2 (model: 17) | ✅ |
feature_bone_mass | Measures bone mass. | Body Pro 2 (model: 17) | ✅ |
feature_water_percent | Measures water percentage. | Body Pro 2 (model: 17) | ✅ |
feature_body_mass_index | Calculates Body Mass Index (BMI). | Body Pro 2 (model: 17) | ✅ |
feature_visceral_fat | Measures visceral fat. | Body Pro 2 (model: 17) | ✅ |
feature_standing_hr | Monitors standing heart rate. | Body Pro 2 (model: 17) | ✅ |
feature_eyes_closed_mode | Hides weight during measurement. | Body Pro 2 (model: 17) | ❌ |
feature_pacemaker | Adjusts for pacemaker users. | Body Pro 2 (model: 17) | ❌ |
feature_vascular_age | Estimates vascular age. | Body Pro 2 (model: 17) | ✅ |
feature_esc | Measures Electrochemical Skin Conductance. | Body Pro 2 (model: 17) (By prescription only) | ❌ |
feature_nhs | Measures Nerve Health Score. | Body Pro 2 (model: 17) (🇪🇺 models only) | ✅ |
feature_pwv | Measures pulse wave velocity. | Body Pro 2 (model: 17) | ❌ |
feature_sleep_rx | Measures sleep Apnea. | Sleep Sensor (model: 63) | ❌ |
Example Request
To activate the feature_eyes_closed_mode
for a user:
{
"action": "enablefeature",
"client_id": "YourClientID",
"signature": "YourSignature",
"nonce": "YourNonce",
"feature_name": "feature_eyes_closed_mode",
"userid": "UserID",
"model": 17
}
This request enables the Eyes Closed Mode for the specified user, focusing on overall progress rather than numbers.
Response from the API
{
"status": 0,
"body": {}
}