End Program API

Use the End of Program API when participants exit your program and retain their devices for personal use.
This API ends cellular billing, and reconfigures the device for individual use with the Withings app via Wi-Fi or Bluetooth Low Energy (BLE).

Caution: This action is permanent and irreversible.
Ensure correct usage as Withings assumes no responsibility for misuse.

Compatible devices

Pro devices

Body Pro
Body Pro 2
BPM Pro

Hub-connected devices

Body
Sleep
BPM Core
BPM Connect

Process Overview

API Call: Call the Devicev2- endpartnerprogram endpoint to initiate the process.
Device Update: Device automatically updates to consumer firmware.
User Interface: Device displays QR code or "Download Withings App" message.
User Setup: End-users can reinstall the device via Withings Mobile App using WiFi or BLE.

Pro Device Example

1. Call the API with status = TERMINATED.
2. Scale updates to consumer firmware (usually within 48h).
3. Scale displays QR code.
4. User scans QR code and sets up BPM Connect via WiFi or BLE in the Withings App.

Hub-Connected Device Example (Hub + BPM Connect)

1. Call the API with status = TERMINATED for both Hub and BPM Connect (two separate calls).
2. BPM Connect updates to consumer firmware (usually within 48h).
3. BPM Connect displays "Download Withings App" message.
4. User downloads Withings app and sets up BPM Connect via WiFi or BLE.

SIM Status

Status	Description
READY	Device has never connected to the cellular network.
ACTIVE	Device has connected to the cellular network at least once.
STANBY	Same has active.
PENDING_TERMINATION	The SIM is in a 30-day countdown period before termination, this allows device to update to the consumer firmware.
TERMINATED	The SIM has been permanently deactivated and can no longer connect to the cellular network.

F.A.Q

Can this proccess be reversed?

The process is final once the device starts updating.
However, you can reverse it by calling the API with status = STANDBY if you realize you made a mistake within a few minutes after the initial call.

What can I do if the device wasn't able to update within the 30-days period?

In that case use Connect Assistant to force the device update via WIFI.

Can I still access the user's data via API after using the End of Program API?

For the EU cloud, you can still access the data as long as the user continues to use the same Withings account from your program. If the user creates a new account, they can choose to link it back to your application using the OAuth2 Web Flow.

On the US cloud, access to data is not available since our consumer devices utilize the EU cloud.

Can the end-user access their historical data?

On the EU cloud, if the user maintains the same account, they will retain access to their historical data.

On the US cloud, the user won't be able to access historical data.

In either case, partners can provide the user with an export compatible with our import function. This allows the user to retrieve their data on a new account.

How can I check that the update was performed on the device?

The update status can be verified via the Fleet Management tab in your developer dashboard.
Please note that the device needs to connect at least once to our servers after the update for the status to be reflected in the Fleet Management tool.

What is the content of the email that is sent to the user?

Here is an example of the email that will be sent to the user (+ a picture of the QR code that will be displayed on the screen of the device after the update).