{"_id":"571838f2c7b52619003f61b8","editedParams":true,"editedParams2":true,"version":{"_id":"56130e2ad2b2370d0096b91d","project":"56130e29d2b2370d0096b91a","__v":11,"createdAt":"2015-10-05T23:56:26.509Z","releaseDate":"2015-10-05T23:56:26.509Z","categories":["56130e2bd2b2370d0096b91e","56130f638e503f0d00648b05","561317cdbe80130d00f188dd","561317d8ff92880d005ca212","56f97c0f8fef7520003f818e","570d751180c9010e00d77f4d","570d7543e2a0b40e0077aa90","571699927256fb0e00c1d01c","57f43db31592cb0e00761dd6","57f52ed668a53b2000e03efa","57f5350f485e6e2b005b2f27"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"parentDoc":null,"project":"56130e29d2b2370d0096b91a","user":"56130dcf8e503f0d00648b03","__v":6,"category":{"_id":"571699927256fb0e00c1d01c","__v":0,"project":"56130e29d2b2370d0096b91a","version":"56130e2ad2b2370d0096b91d","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-19T20:48:18.215Z","from_sync":false,"order":0,"slug":"sites","title":"Reference"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-21T02:20:34.815Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X PUT 'https://api.stacklighting.com/v0/sites/6133345811384985/zones/6022860457570431/settings' \\\n     -H 'Content-Type: application/json' \\\n     -H 'Authorization: Bearer YmE3MTU5MWItZTIwMC00MDc2LWJmZTQtZDH5YmUxMTA0ZTNmOjU3NjE2NzM5MzE1MjIwNDg=' \\\n     -d '{\"brightness\":2000}' "}]},"method":"put","results":{"codes":[{"code":"{\n\t\"als_adjust_on\": true, \n\t\"als_adjust_floor\": 200, \n\t\"color\": 2700, \n\t\"brightness\": 2000, \n\t\"motion_timeout_seconds\": 15, \n\t\"motion_timeout_on\": true\n}","language":"json","status":200,"name":""}]},"settings":"","auth":"required","params":[{"_id":"571849e3a100fc0e006bbd92","ref":"","in":"path","required":true,"desc":"The unique identifier for the site.","default":"","type":"string","name":"site_id"},{"_id":"571849e3a100fc0e006bbd91","ref":"","in":"path","required":true,"desc":"The unique identifier for the zone.","default":"","type":"string","name":"zone_id"},{"_id":"571849e3a100fc0e006bbd83","ref":"","in":"body","required":false,"desc":"The current Correlated Color Temperature (CCT) in Kelvins, ranging from 2000 - 6500. (Note: the Stack Downlight has a CCT range of 2700 - 6500.)","default":"","type":"int","name":"color"},{"_id":"571849e3a100fc0e006bbd8d","ref":"","in":"body","required":false,"desc":"The brightness level used while in Manual mode, ranging from 0 - 2000.","default":"","type":"int","name":"brightness"},{"_id":"571849e3a100fc0e006bbd90","ref":"","in":"body","required":false,"desc":"Whether Ambient Light Sensing is enabled.","default":"","type":"boolean","name":"als_adjust_on"},{"_id":"571849e3a100fc0e006bbd85","ref":"","in":"body","required":false,"desc":"The lowest brightness that bulbs should be able to dim to when Ambient Light Sensing is enabled.","default":"","type":"int","name":"als_adjust_floor"},{"_id":"571849e3a100fc0e006bbd87","ref":"","in":"body","required":false,"desc":"Whether a motion timeout should be used, and if so, whether it is determined by Stack or user-specified.<br>\"Off\":  The bulbs should not turn off after prolonged periods of no detected motion.<br>\"Auto\":  Allow Stack to determine the appropriate motion timeout for the zone.<br>\"On\":  Use the user-specified motion timeout for the zone (motion_timeout).","default":"","type":"boolean","name":"motion_timeout_on"},{"_id":"571849e3a100fc0e006bbd86","ref":"","in":"body","required":false,"desc":"How many seconds after no motion has been detected before the bulbs will begin to turn off.","default":"","type":"int","name":"motion_timeout_seconds"}],"url":"/sites/:site_id/zones/:zone_id/settings"},"isReference":true,"order":4,"body":"","excerpt":"This endpoint updates information for a zone's settings.","slug":"put-zone-settings","type":"endpoint","title":"Zone Settings"}

putZone Settings

This endpoint updates information for a zone's settings.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
required
string
The unique identifier for the site.
zone_id:
required
string
The unique identifier for the zone.

Body Params

color:
integer
The current Correlated Color Temperature (CCT) in Kelvins, ranging from 2000 - 6500. (Note: the Stack Downlight has a CCT range of 2700 - 6500.)
brightness:
integer
The brightness level used while in Manual mode, ranging from 0 - 2000.
als_adjust_on:
boolean
Whether Ambient Light Sensing is enabled.
als_adjust_floor:
integer
The lowest brightness that bulbs should be able to dim to when Ambient Light Sensing is enabled.
motion_timeout_on:
boolean
Whether a motion timeout should be used, and if so, whether it is determined by Stack or user-specified.<br>"Off": The bulbs should not turn off after prolonged periods of no detected motion.<br>"Auto": Allow Stack to determine the appropriate motion timeout for the zone.<br>"On": Use the user-specified motion timeout for the zone (motion_timeout).
motion_timeout_seconds:
integer
How many seconds after no motion has been detected before the bulbs will begin to turn off.

Examples


Result Format


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}