Health API (Beta)

post /users/{user_id}/devices

Register device

Base URL https://api.vseepreview.com/api_v3 · operationId registerDevice

Authentication: User Token — Requires a user access token from login or SSO.

Register a health monitoring device for a user

Parameters

NameInTypeRequiredEnumDefaultDescription
X-ApiTokenheaderstringyesAPI token (e.g. your_api_token)
X-ApiKeyheaderstringyesAPI Key (e.g. your_api_key)
X-AccountCodeheaderstringyesAccount code (e.g. vclinic)
user_idpathstringyesUser ID

Request body

Content type: application/json

FieldTypeRequiredEnumDescription
device_idstringyesDevice unique identifier
device_namestringyesHuman-readable device name
typestringyesihealth_po_po3, ihealth_scale_hs2, applehealth, samsunghealth, welchallync_bp_bp100, ihealth_bg_bg5s, ihealth_thermometer_pt3sbtDevice type code

Example:

{
  "device_id": "004D320DCAA2",
  "device_name": "Thermometer PT3SBT",
  "type": "ihealth_thermometer_pt3sbt"
}

Responses

200 — Device registered successfully

{
  "data": {
    "device_id": "string",
    "device_name": "string",
    "type": "string",
    "user_id": "string",
    "created_at": 0
  }
}

Machine-readable: OpenAPI JSON (operationId: registerDevice)