Unlinking Gateways from Devices

In order to deactivate a HWI device or re-use the attached Gateway with another HWI Device, you must first either delete the HWI device or Unlink the Gateway. When a Gateway is unlinked, this will stop data transmission as well as data fees.

/hwi/unlink-gateway/{hwi_device_id}/

To use this endpoint, you must perform a GET request with the HWI Device id included in the URL. If it is successful, the HWI Device object will be returned with the hardware_uuid field of the nested Device object set to null.

See our API Reference for more information on this API endpoint.

Deleting a Device vs Unlinking

As HWI Devices with a Fulfillment Request cannot be deleted once that Request has been fulfilled, it is recommended to use the unlink-gateways endpoint to deactivate devices, as it is guaranteed to always succeed.

A common scenario as to why a device cannot be deleted is that it has already left our fulfillment facility and has been collecting measurements from a patient already. In this instance you can unlink the device but not delete it.

Unlinking Many Devices at Once

If you need to unlink devices in bulk for a device audit, patient unenrollment, or hardware reclamation, see our Bulk Unlinking Devices recipe. It covers building an accurate device list, pacing the calls against the rate limit, and verifying that each Gateway ends up fully cleared.