# Update Global Settings

This endpoint allows the manipulation of key global configuration options for leaf/node (where applicable) sounding behaviour.

Endpoint: PATCH /sounding/settings
Security: Authorization

## Query parameters:

  - `update` (boolean)
    Default: false
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):

  - `zone_priority_list` (array)
    The zone_priority_list is a list of locations within a WiFi Motion network that is configured by the end user.  The list indicates which rooms are within the user's dwelling and can be used to map WiFi devices with the rooms that they are located in.  The zone_priority_list is used to help determine which devices to be used for placement when the Default Sounding Mode is enabled.  The order of the list identifies the user's priorities, with the locations at the top of the list being considered the top priority.

  - `motion_events_enabled` (integer)
    Enable motion events. On detected motion, the network emits a MotionDetectedEvent.
    Enum: 0, 1

  - `device_events` (integer)
    Enable Device Connection Events. 

 Requires global sounding_mode to equal deny and individual devices' sounding_mode to equal allow. When the connection state of device changes, an event is emitted. Possible events are: DeviceConnectedEvent, DeviceDisconnectedEvent and DeviceTimedOutEvent
    Enum: 0, 1

  - `motion_history_enabled` (number)
    Enable historical motion data from the network. The data can be queried through the Motion History APIs.
    Enum: 0, 1

  - `mesh_auto_disable` (integer)
    Disable motion detection on all current and added mesh nodes.
    Enum: 0, 1

  - `motion_events_armed` (integer)
    Enable storage of motion events. Requires motion_events_enabled to be enabled. The stored events can be queried through the Events APIs.
    Enum: 0, 1

  - `motion_paused` (integer)
    Pauses all motion detection. While paused, the network can't receive setting changes.
    Enum: 0, 1

  - `leafblower_cutoff` (number)
    Advanced - Minimum score for device selection algorithm.
 Set to -1.1 to ignore device quality, and always use them for motion detection. This feature should be used in conjunction with the sounding_mode features.

  - `link_limit` (number)
    Maximum number of motion-detecting devices per access point or mesh node

  - `pet_mode` (integer)
    When enabled, pet motion is less likely to generate a MotionDetectedEvent. Can only be used when global sensitivity is set to high (1.0) and all clients' sensitivity_mode is global.
    Enum: 0, 1

  - `cooldown` (integer)
    Represents the duration of inactivity following a MotionDetectedEvent, that the network keeps monitoring for motion. Once inactivity is observed, the network emits a MotionStoppedEvent and concludes the event window.

  - `sensitivity` (number)
    Global motion detection sensitivity (1.0 - high, 2.0 - medium, 3.0 - low, 7.0 - very-low)

  - `sounding_mode` (string)
    This parameter controls the default leaf selection policy for the network, the two policy modes are allow and deny.

Allow mode: leafs will be selected as best determined by leaf blower. Leaf(s) can be blocked from selection by setting txenble=0 for that leaf(s).

Deny mode: leafs that are not explicitly listed via a whitelist will be disallowed from sounding.

 Note switching this mode will clear any existing device device availability settings and all devices will revert to available for allow mode or unavailable for deny mode.
    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.