nexalwarenexalwaredocs
API ReferenceSub devices

Enable or disable a sub-device

PATCH
/api/v1/devices/{deviceId}/sub-devices/{subDeviceId}/toggle

Disabling a sub-device stops the master from accepting further commands for it (any command/command/on/command/off request targeting a disabled sub-device 404s), it does not remove it - state, telemetry history and its declared capabilities stay intact and it can be re-enabled at any time. Requires the same grant a command against this sub-device would need. Body is optional - omit it to flip the current state, or pass enabled explicitly.

Authorization

AuthorizationBearer <token>

A session token for an existing account, obtained from POST /auth/login (see the Authentication endpoints) - not an API key. Endpoints marked with this scheme reject API key callers outright, regardless of what that key is granted. Outside the Authentication endpoints themselves, everything requiring this scheme manages dashboard resources (rules, grants, keys, device configuration, command catalogs) and mirrors what a human does in the Nexalware web app - it is not meant to be automated by a third-party integration the way the Device Control and Schedules endpoints are.

In: header

Path Parameters

deviceId*string
subDeviceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/devices/dev_a1b2c3/sub-devices/sub_x1y2z3/toggle" \  -H "Content-Type: application/json" \  -d '{    "enabled": false  }'
{  "ok": true,  "enabled": false,  "message": "Sub-device disconnected"}