{"_id":"56c50633bdcde80d004986ba","editedParams":true,"editedParams2":true,"parentDoc":null,"category":{"_id":"56c50628bdcde80d00498645","version":"56c50626bdcde80d00498635","__v":1,"project":"54774d9af3736008009e9e0e","pages":["56c50633bdcde80d004986b7","56c50633bdcde80d004986b8","56c50633bdcde80d004986b9","56c50633bdcde80d004986ba","56c50633bdcde80d004986bb","56c50633bdcde80d004986bc","56c50633bdcde80d004986bd","56c50633bdcde80d004986be","56c50633bdcde80d004986bf"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-05-21T13:12:14.654Z","from_sync":false,"order":19,"slug":"channels","title":"Channels"},"user":"54774c47f3736008009e9e0c","version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"project":"54774d9af3736008009e9e0e","__v":0,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-22T09:41:19.973Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl -X PUT \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"X-USER-KEY: USER_KEY\" \\\n-H \"Content-type: application/json\" \\\n-d '{\"group\": 1, \n\t\t\"group_permissions\": \"publish\", \n    \"other_permissions\": \"publish\", \n    \"custom_publish\": true, \n    \"type\": \"default\", \n    \"description\": \"a new channel\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance>/channels/<channel_name>/\"","language":"curl","gist":"47d76024a9729f415058"},{"code":"import syncano\nfrom syncano.models import Channel\n\nsyncano.connect(api_key=\"API_KEY\", userKey=\"USER_KEY\", instance_name=\"INSTANCE_NAME\")\n\nChannel.please.update(\n    name=\"channel_with_rooms\",\n    custom_publish=False\n)\n","language":"python"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY\", userKey: \"USER_KEY\"});\nvar Channel = connection.Channel;\n\nvar query = {\n  \"name\":\"channel_with_rooms\",\n  \"instanceName\": \"INSTANCE_NAME\"\n};\nvar update = {\n  \"other_permissions\": \"publish\",\n  \"custom_publish\": \"true\",\n  \"description\": \"channel description\"\n};\n\nChannel.please().update(query, update).then(callback);"}]},"method":"put","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"group\": 1,\n  \"name\": \"new-channel\",\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/channels/new-channel/\",\n    \"poll\": \"/v1.1/instances/rivia/channels/new-channel/poll/\",\n    \"group\": \"/v1.1/instances/rivia/groups/1/\",\n    \"publish\": \"/v1.1/instances/rivia/channels/new-channel/publish/\",\n    \"history\": \"/v1.1/instances/rivia/channels/new-channel/history/\"\n  },\n  \"group_permissions\": \"publish\",\n  \"other_permissions\": \"publish\",\n  \"updated_at\": \"2016-03-17T20:04:47.791327Z\",\n  \"custom_publish\": true,\n  \"type\": \"default\",\n  \"created_at\": \"2016-03-17T20:04:47.791302Z\",\n  \"description\": \"a new channel\"\n}"},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"code":"{\n  \"detail\": \"Not found\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"555ddf718ab3180d001ac55f","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"555e12ab06dfec0d00d39063","ref":"","in":"path","required":true,"desc":"Channel name","default":"","type":"string","name":"name"},{"_id":"558d5404572f1f2300db061d","ref":"","in":"body","required":false,"desc":"Channel description","default":"","type":"string","name":"description"},{"_id":"555e15c006dfec0d00d39072","ref":"","in":"body","required":false,"desc":"Flag indicating whether users can publish custom notification messages to a Channel. Can be `true` or `false`","default":"","type":"boolean","name":"custom_publish"},{"_id":"555e15c006dfec0d00d39071","ref":"","in":"body","required":false,"desc":"Group ID of a group associated with the Channel","default":"","type":"int","name":"group"},{"_id":"555e15c006dfec0d00d39070","ref":"","in":"body","required":false,"desc":"Permission of users inside a group associated with the Channel. Can be of type: `subscribe` or `publish`","default":"","type":"string","name":"group_permssions"},{"_id":"555e15c006dfec0d00d3906f","ref":"","in":"body","required":false,"desc":"Permission of users not belonging to a group associated with the Channel. Can be of type: `subscribe` or `publish`","default":"","type":"string","name":"other_permissions"}],"url":"/instances/:instance_name/channels/:name/"},"isReference":true,"order":3,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please notice, that's it's not possible to change channel type after it was created. Objects with channels assigned, need to have either room specified or not (depending on channel type). \\nBecause it's not possible to change channel/room info on objects after their creation, changing channel type is also not possible.\",\n  \"title\": \"Channel Type\"\n}\n[/block]\nUpdate an existing Channel.","excerpt":"","slug":"channels-update-put","type":"endpoint","title":"Channels - update"}

putChannels - update


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
name:
required
string
Channel name

Body Params

description:
string
Channel description
custom_publish:
boolean
Flag indicating whether users can publish custom notification messages to a Channel. Can be `true` or `false`
group:
integer
Group ID of a group associated with the Channel
group_permssions:
string
Permission of users inside a group associated with the Channel. Can be of type: `subscribe` or `publish`
other_permissions:
string
Permission of users not belonging to a group associated with the Channel. Can be of type: `subscribe` or `publish`

Examples


Result Format


Documentation

[block:callout] { "type": "info", "body": "Please notice, that's it's not possible to change channel type after it was created. Objects with channels assigned, need to have either room specified or not (depending on channel type). \nBecause it's not possible to change channel/room info on objects after their creation, changing channel type is also not possible.", "title": "Channel Type" } [/block] Update an existing Channel.

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