Skip to content
PassionPassion developers

Open a new channel in a community

POST
/apps/{appId}/communities/{communityId}/channels
curl --request POST \
  --url https://api.passion.io/v1/apps/example/communities/example/channels \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
appId
required

The id of the App, as Studio shows it.

string
/^[1-9][0-9]*$/
communityId
required

The id of a community, as the App overview lists it.

string
/^[1-9][0-9]*$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

The name of the channel, for example “Introductions”.

string
>= 1 characters
description

What the channel is for. Members see it under the name.

string
Examplegenerated
{
  "name": "example",
  "description": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
channelId
required
string
communityId
required
string
name
required
string
description
required
Any of:
string
Examplegenerated
{
  "channelId": "example",
  "communityId": "example",
  "name": "example",
  "description": "example"
}