{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id","auth":"required","results":{"codes":[{"name":"","code":"No Output","language":"text","status":200},{"name":"Conduit Invalid","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"message\": \"invalid id\",\n            \"path\": \"id\"\n        }\n    ]\n}","language":"json","status":400},{"status":400,"name":"Invalid Body Parameter","language":"json","code":"{\n    \"errorType\": \"InvalidBody\",\n    \"errors\": [\n        {\n            \"path\": \"fakeParameter\",\n            \"message\": \"'fakeParameter' is not a valid configuration option\"\n        }\n    ]\n}"},{"status":404,"name":"Conduit Not Found","language":"text","code":"Conduit with id 5adb49d1e817132aa4d6ec85 does not exist."}]},"settings":"59f773da3624640026dc9e8e","params":[{"name":"id","type":"string","default":"","desc":"The ID of the desired conduit.","required":true,"in":"path","ref":"","_id":"5b4647d6e1e0000003488b70"},{"name":"label","type":"string","default":"","desc":"The custom label assigned to the conduit.","required":false,"in":"body","ref":"","_id":"5b4647d6e1e0000003488b6f"},{"name":"config","type":"object","default":"","desc":"A JSON object containing the configuration data for the conduit. (domain, clientId, clientSecret, callback)","required":false,"in":"body","ref":"","_id":"5b4647d6e1e0000003488b6e"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b4647d6e1e0000003488b6d"},{"name":"content-type","type":"string","default":"","desc":"Specify that the sent data will be a JSON object.","required":true,"in":"header","ref":"","_id":"5b4647d6e1e0000003488b6c"}],"examples":{"codes":[{"language":"http","code":"PUT https://ioe.droplit.io/api/conduits/5aa6880f39e1bcc43946a2f1 HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"label\": \"changedNestConduit\",\n\t\"config\": {\n\t\t\"domain\": \"https://home.nest.com/login/oauth2?client_id=714bd531-9f81-4e17-a50c-7feb20d1140a&state=STATE\",\n\t\t\"clientId\": \"714bd531-9f81-4e17-a50c-7feb20d1140a\",\n\t\t\"callback\": \"https://yo.droplit.io/auth/newCallback\"\n\t}\n}"},{"name":"Droplit SDK","language":"javascript","code":"droplit.conduits.updateInstalledConduit(\"5aa6880f39e1bcc43946a2f1\", {\n  \"label\": \"changedNestConduit\",\n\t\"config\": {\n\t\t\"domain\": \"https://home.nest.com/login/oauth2?client_id=714bd531-9f81-4e17-a50c-7feb20d1140a&state=STATE\",\n\t\t\"clientId\": \"714bd531-9f81-4e17-a50c-7feb20d1140a\",\n\t\t\"callback\": \"https://yo.droplit.io/auth/newCallback\"\n\t}\n});"}]},"method":"put"},"next":{"description":"","pages":[]},"title":"Update a conduit.","type":"endpoint","slug":"update-a-conduit","excerpt":"Update a conduit's parameters.","body":"","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b464362e1e0000003488b31","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Conduits API","slug":"conduits-api","order":17,"from_sync":false,"reference":false,"_id":"59f76fef8581dc0010593e6f","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2017-10-30T18:31:11.732Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-07-11T17:50:26.289Z","githubsync":"","__v":4,"parentDoc":null}

putUpdate a conduit.

Update a conduit's parameters.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the desired conduit.

Body Params

label:
string
The custom label assigned to the conduit.
config:
object
A JSON object containing the configuration data for the conduit. (domain, clientId, clientSecret, callback)

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


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