---
title: "User v2 - Addtorpm"
method: POST
path: "https://wbsapi.withings.net/v2/user      "
tags: ["user"]
---

# User v2 - Addtorpm

`POST https://wbsapi.withings.net/v2/user      `

## Request

- Base URL: `https://wbsapi.withings.net`
- URL: `https://wbsapi.withings.net/https://wbsapi.withings.net/v2/user      `
- Auth: none declared

This API allows you to add an existing user to the Withings Remote Patient Monitoring platform as a patient. Note: A Withings Remote Patient Monitoring contract is required to use this API.

## Query parameters

- `action` string, required
- `signature` string, required
- `client_id` string, required
- `nonce` string, required
- `userid` unknown, required
- `programid` integer, required
- `sms_onboarding` boolean
- `assistance_onboarding` boolean
- `icdcodeids` unknown
- `external_ids` unknown
- `department` string
- `category` integer

## Response `200`

(Click to unfold)

- object
  - `status` integer: Response status. See <a href='#tag/response_status'>Status</a> section for details.
  - `body` object: Response data.
    - `user` object
      - `preflang` string: User's language preference. Examples: en_EN / en_US / de_DE / es_ES / fr_FR / it_IT / ja_JA / ko_KR / nl_NL / pt_PT / ru_RU / zh_CN
      - `height` object
        - `value_measure` integer
        - `unit_measure` integer
        - `type_measure` integer
      - `sms_reminder` boolean
      - `sms_onboarding` boolean
      - `assistance_onboarding` boolean
      - `category` integer
      - `device_types` integer[]
      - `device_models` integer[]
      - `external_ids` UserAddToRpmExternalIds[]
        - `type` string: Type of the measure. See ```meastype``` input parameter.
        - `identifier` string
      - `sms_notification` boolean
      - `icd_codes` integer[]
      - `userid` integer: The id of the user.
    - `program` object
      - `id` integer
      - `cohortid` integer
      - `name` string
      - `timezone` string: Timezone for the date.
    - `department` string: Patient's department. **Only returned when** the ```department``` input parameter was provided **and** the care team has a Redox integration configured. Absent when either condition is not met.

---

[API](https://skmtc.dev/withings/apis/withings-developer-documentation.md) - [All operations](https://skmtc.dev/withings/apis/withings-developer-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/withings/apis/withings-developer-documentation/revisions/9e9accd01d4b?raw)