{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/channels/","auth":"required","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"555ddf718ab3180d001ac55f"},{"name":"name","type":"string","default":"","desc":"Channel name","required":true,"in":"body","ref":"","_id":"555e12ab06dfec0d00d39063"},{"name":"type","type":"string","default":"","desc":"Channel type. Can be of type: `default` or `separate_rooms`","required":true,"in":"body","ref":"","_id":"555e15c006dfec0d00d39073"},{"name":"description","type":"string","default":"","desc":"Channel description","required":false,"in":"body","ref":"","_id":"558d53d9beb7c719007f6242"},{"name":"custom_publish","type":"boolean","default":"","desc":"Flag indicating whether users can publish custom notification messages to a Channel. Can be `true` or `false`","required":false,"in":"body","ref":"","_id":"555e15c006dfec0d00d39072"},{"name":"group","type":"int","default":"","desc":"Group ID of a group associated with the Channel","required":false,"in":"body","ref":"","_id":"555e15c006dfec0d00d39071"},{"name":"group_permssions","type":"string","default":"","desc":"Permission of users inside a group associated with the Channel. Can be of type: `subscribe` or `publish`","required":false,"in":"body","ref":"","_id":"555e15c006dfec0d00d39070"},{"name":"other_permissions","type":"string","default":"","desc":"Permission of users not belonging to a group associated with the Channel. Can be of type: `subscribe` or `publish`","required":false,"in":"body","ref":"","_id":"555e15c006dfec0d00d3906f"}],"results":{"codes":[{"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}","name":"","status":201,"language":"json"},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"gist":"47d76024a9729f415058","language":"curl","code":"curl -X POST \\\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\"name\": \"new-channel\", \n\t\t\"group_permissions\": \"publish\", \n\t\t\"other_permissions\": \"publish\", \n\t\t\"custom_publish\": true, \n\t\t\"type\": \"default\", \n\t\t\"description\": \"a new channel\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance>/channels/\"","name":""},{"code":"import syncano\nfrom syncano.models import Channel\n\nsyncano.connect(api_key=\"API_KEY\", user_key=\"USER_KEY\", instance_name=\"INSTANCE_NAME\")\n\nChannel.please.create(\n    name=\"channel_with_rooms\",\n    description=\"channel description\",\n    type=\"separate_rooms\",\n    other_permissions=\"publish\",\n    custom_publish=True\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 options = {\n  \"name\":\"channel_with_rooms\",\n  \"type\":\"separate_rooms\",\n  \"other_permissions\": \"publish\",\n  \"custom_publish\": \"true\",\n  \"description\": \"channel description\",\n  \"instanceName\": \"INSTANCE_NAME\"\n};\n\nChannel.please().create(options).then(callback);"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Channels - add","type":"endpoint","slug":"channels-add","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"When creating a new channel, please pay attention to it's type - it's not possible to change it later. \\nObjects 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]\nAdd a new Channel.","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50633bdcde80d004986b9","project":"54774d9af3736008009e9e0e","category":{"sync":{"isSync":false,"url":""},"pages":["56c50633bdcde80d004986b7","56c50633bdcde80d004986b8","56c50633bdcde80d004986b9","56c50633bdcde80d004986ba","56c50633bdcde80d004986bb","56c50633bdcde80d004986bc","56c50633bdcde80d004986bd","56c50633bdcde80d004986be","56c50633bdcde80d004986bf"],"title":"Channels","slug":"channels","order":19,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498645","version":"56c50626bdcde80d00498635","__v":1,"createdAt":"2015-05-21T13:12:14.654Z","project":"54774d9af3736008009e9e0e"},"parentDoc":null,"__v":0,"editedParams":true,"version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"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"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"createdAt":"2015-05-21T17:15:43.788Z","githubsync":"","user":"54774c47f3736008009e9e0c","editedParams2":true}

postChannels - add


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Body Params

name:
required
string
Channel name
type:
required
string
Channel type. Can be of type: `default` or `separate_rooms`
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": "When creating a new channel, please pay attention to it's type - it's not possible to change it later. \nObjects 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] Add a new Channel.

User Information

Try It Out

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