You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This method can be used to create a new channel with the given name, image and purpose. It takes a list of members that are to be added to the channel. The user whose token is used to create the channel is also added to the channel. The method returns the channel id in the response.

The method endpoint is https://api.flock.co/v1/channels.create and follows the method calling conventions.

Parameters

NameTypeRequiredDescription
tokenStringYesAuthentication token of the user creating the channel
nameStringYesName of the channel (max 255 characters)
purposeStringNoChannel purpose
profileImageStringNoURL of the channel's profile image
typeStringNoCan be "public" or "private". Set to "private" by default.
membersArrayYesA list of user identifiers to be added to the channel

Response

In response, the channel identifier is returned.

{
    "id": "g:fd4877b719b1"
}