social.colibri.beta.channel.update
Updates a channel's configuration. An absent field leaves the current value unchanged.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | channel.beta.colibri.social |
| Indexed |
Procedure
procedure · POSTInput
application/jsonallowedMembers
arrayMembers allowed to post here in addition to allowedRoles. Absent leaves the current value unchanged.
A member permitted to post.
allowedRoles
arrayRoles allowed to post here. Absent leaves the current value unchanged.
A role permitted to post.
category
string · record-keyThe category to move the channel to. Absent leaves the current value unchanged.
The channel to update.
description
stringThe channel's topic. Absent leaves the current value unchanged.
maxLength: 256
linkEmbeds
booleanWhether link previews are shown here. Absent leaves the current value unchanged.
name
stringThe channel's name. Absent leaves the current value unchanged.
minLength: 1maxLength: 32
ownerOnly
booleanWhether only community admins may post. Absent leaves the current value unchanged.
removeLinkEmbeds
booleanClears the channel's link preview setting so the community default applies. Ignored when linkEmbeds is also given.
visibleToMembers
arrayMembers that may read this channel beyond visibleToRoles.
A member.
visibleToRoles
arrayRoles that may read this channel. Empty means every member may.
A role.
Output
application/jsonThe channel, after the update.
Errors
AuthRequired
The request has no valid service auth.
Forbidden
The requesting user lacks the channel.update permission.
ChannelNotFound
No channel matches the given space reference.
CategoryNotFound
No category matches the given record key.
RoleHierarchy
The requesting user cannot grant a role that outranks their own.
CredentialsUnavailable
The AppView cannot act as the community because its stored credentials are missing or unusable.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
social.colibri.channel.update
procedureUpdates a channel's settings.
-
social.colibri.beta.category.update
procedureUpdates a category's name and the permissions its channels inherit.
-
social.colibri.beta.channel
recordA channel's configuration. Lives at key 'self' in the channel's own space. The space type says whether it is a text or voice channel, and the space key is the channel's identity.
-
social.colibri.beta.channel.create
procedureCreates a channel. This creates a space for the channel, then writes the channel's configuration record at key 'self' inside that space.
-
social.colibri.channel
recordA channel that belongs to a category on Colibri.