# Update Client Configuration

Update sounding client(s) configuration. Note: Multi-Link Operation (MLO) devices with peer_type 2 are not configurable.

Endpoint: PATCH /network/{network_id}/sounding/clients
Security: ApiKey

## Path parameters:

  - `network_id` (integer, required)
    The Network ID is a unique identifier that is assigned to a WiFi Motion network when it is created.  The Network ID is used by applications such as AppCloud, Device Manager, and via APIs, to uniquely identify a network.

## Query parameters:

  - `update` (boolean)
    When true the new configuration is immediately propagated to the network this node is part of.

 If this value is false, the change will be propagated to edge either when the device is rebooted or an update is triggered.

## Request fields (application/json):

  - `devices` (array, required)
    Example: [{"id":0,"location":"LocationA"},{"mac":"00:11:22:33:44:55","sensitivity":1,"sounding_mode":"allow"}]

  - `devices.mac` (string)
    The Mac address of the target device.
    Example: "22:33:44:ff:ee:dd"

  - `devices.device_id` (string)
    Contains the Serial number, Node Id, or Device ID.

  - `devices.id` (string)
    Internal node_id or device_id of the target node.

  - `devices.friendly_name` (string)
    The term Friendly Name, also known as friendly_name, refers to a name that is easy for the end user to understand.  For example, if referring to a location, it is easier for an end user to refer to a location as _Bedroom_ rather than the mac address of the device that is located in the bedroom.
    Example: "name"

  - `devices.location` (string)
    Device location name assigned to the Device or Node. Maximum of 256 characters, supporting letters, spaces, digits, with only the following special characters: =, +, -, _, @, !. Supports base64 encoding. Can also be an empty string.
    Example: "location"

  - `devices.sensitivity_mode` (string)
    Indicates whether the device is using the global sensitivity setting or is being overridden at the device level.
    Enum: "override", "global"

  - `devices.sensitivity` (number)
    Below is a chart that provides a description of the different Sensitivity Levels that are available:

{% table %}

- Sensitivity Level {% width="15%" %}
- Description {% width="65%" %}
- Numerical Representation


---

- High
- Motion levels of all sizes will trigger detection.  Provides optimal coverage for most single family / detached dwellings.
- 1

---

- Medium
- Motion levels that are moderate or greater will trigger detection.  Provides optimal coverage for most dwellings that share one or more walls with a neighbor.
- 2

---

- Low
- Only motion levels that are large to intense will trigger detection.  Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting.
- 3

---

- Very Low 
- Only motion levels that are large to intense will trigger detection.  This setting is typically only used in scenarios such as a small accommodation with shared walls.  Low and Very Low sensitivity may result in missed motion and are only recommended if too much motion is being reported at a higher setting.
- 7

---

{% /table %}

  - `devices.sounding_mode` (string)
    Controls if the device can be used for sounding.
    Enum: "allow", "deny"

  - `devices.sounding_mesh` (string)
    Applicable only to nodes. Controls if the node will accept or reject sounding on mesh links.
    Enum: "allow", "deny"

## Response 200 fields (application/json):

  - `status` (integer)
    0 failure

1 full success

2 some changes failed

3 an IoT update was requested but network has not yet started up

  - `success` (integer)
    1 if the operation was successful, 0 otherwise

  - `details` (object)
    The list of warnings or errors that occurred during processing of this request.

  - `details.warnings` (array)

  - `details.warnings.msg` (string)
    The message for the warning.

  - `details.warnings.id` (string)
    The ID of the error message.

  - `details.errors` (array)

## Response 400 fields (application/json):

  - `error` (string)
    Error Type

  - `message` (string)
    Reason for failure

  - `statusCode` (integer)
    HTTP Status code for the given error.

  - `validation` (object)
    object containing the items that failed validation.

## Response 404 fields (application/json):

  - `error` (string)
    network not found
    Example: "something went wrong"


## Response 422 fields