{"_id":"5aa82777ebb96800bd78bba0","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":23,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c06c40df5b3c0010584a13","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-19T01:00:48.384Z","from_sync":false,"order":11,"slug":"devices-api","title":"Devices API"},"user":"5a6a26281895510045b2cd40","__v":14,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-13T19:33:11.338Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"59a750fbd61777001b6c47ed","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"transactionId\": \"50a822b453ee389c1f0a4db1\"\n}","name":"Without \"verify\""},{"code":"[\n    {\n        \"serviceMember\": \"BinarySwitch[0].switch\",\n        \"status\": \"Accepted\"\n    }\n]","language":"json","status":200,"name":"With \"verify\""},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"message\": \"invalid id\",\n            \"path\": \"id\"\n        }\n    ]\n}","language":"json","name":"Device Invalid","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"contains fields that are not allowed: [ query ]\",\n            \"path\": \"additional parameters\"\n        }\n    ]\n}","language":"json","status":400,"name":"Invalid Query String"},{"code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"message\": \"value was undefined\"\n        }\n    ]\n}","language":"json","name":"Body Parameters Missing","status":400},{"code":"Device with id D5a22e634e44f8cd804132f21 does not exist.","language":"text","name":"Device Not Found","status":404}]},"examples":{"codes":[{"code":"PUT https://ioe.droplit.io/api/devices/D5a2ae639e4438cda041f2f21/services/BinarySwitch.switch HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n{\n\t\"value\": \"off\"\n}","language":"http","name":"Without \"verify\""},{"code":"PUT https://ioe.droplit.io/api/devices/D5a2ae639e4438cda041f2f21/services/BinarySwitch.switch?verify=true HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n{\n\t\"value\": \"off\"\n}","language":"http","name":"With \"verify\""},{"code":"droplit device set D5a2ae639e4438cda041f2f21 BinarySwitch.switch off","language":"text","name":"Droplit Console"}]},"method":"put","auth":"required","params":[{"_id":"59c189a8bc639a0032f77680","ref":"","in":"path","required":true,"desc":"The ID of the device","default":"","type":"string","name":"id"},{"_id":"59c189a8bc639a0032f7767f","ref":"","in":"path","required":true,"desc":"The full name of the service of the format SERVICE_NAME.PROPERTY","default":"","type":"string","name":"selector"},{"_id":"59c189a8bc639a0032f7767e","ref":"","in":"body","required":true,"desc":"The desired value of the specified service property","default":"","type":"string","name":"value"},{"_id":"5aa839960c725800bd56584d","ref":"","in":"header","required":true,"desc":"The user's authorization token","default":"","type":"string","name":"authorization"},{"_id":"5aa839960c725800bd56584c","ref":"","in":"header","required":true,"desc":"Specify that the sent data will be a JSON object","default":"","type":"string","name":"content-type"},{"_id":"5abb98a6ed190c001275766c","ref":"","in":"query","required":false,"desc":"When set to true, wait until the value has been set before returning","default":"False","type":"boolean","name":"verify"}],"url":"/:id/services/:selector"},"isReference":false,"order":10,"body":"Call a device service method.\n\nAn account token, server token, or user token may be used to run this endpoint.\n\nIf there are any webhooks in the ecosystem listening for \"Set\" service notifications, their response, an example of which may be seen on the [Webhooks v2](doc:webhooks-v2) page, will include both the user's account type and ID.","excerpt":"","slug":"devices-services-update","type":"endpoint","title":"Update Service Property"}

putUpdate Service Property


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the device
selector:
required
string
The full name of the service of the format SERVICE_NAME.PROPERTY

Query Params

verify:
booleanFalse
When set to true, wait until the value has been set before returning

Body Params

value:
required
string
The desired value of the specified service property

Headers

authorization:
required
string
The user's authorization token
content-type:
required
string
Specify that the sent data will be a JSON object

Examples


Result Format


Documentation

Call a device service method. An account token, server token, or user token may be used to run this endpoint. If there are any webhooks in the ecosystem listening for "Set" service notifications, their response, an example of which may be seen on the [Webhooks v2](doc:webhooks-v2) page, will include both the user's account type and ID.

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 }}