social.colibri.beta.category.update
Updates a category's name and the permissions its channels inherit.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | category.beta.colibri.social |
| Indexed |
Procedure
procedure · POSTInput
application/jsonallowedMembers
arrayMembers allowed to post in the category's channels in addition to allowedRoles. Absent leaves the current value unchanged.
A member permitted to post.
allowedRoles
arrayRoles allowed to post in the category's channels. Absent leaves the current value unchanged.
A role permitted to post.
The category's record key.
The community the category belongs to.
name
stringThe category's new name.
minLength: 1maxLength: 32
ownerOnly
booleanWhether only community admins may post in the category's channels. Absent leaves the current value unchanged.
visibleToMembers
arrayMembers that may read the category's channels in addition to visibleToRoles. Absent leaves the current value unchanged.
A member permitted to read.
visibleToRoles
arrayRoles that may read the category's channels. Absent leaves the current value unchanged.
A role permitted to read.
Output
application/jsonThe updated category.
Errors
AuthRequired
The request is missing, malformed, or unverifiable service auth.
Forbidden
The caller lacks the category.update permission, or grants visibility to a role at or above their own highest position.
CommunityNotFound
No community exists at the given DID.
CategoryNotFound
No category exists at the given record key.
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.beta.channel.update
procedureUpdates a channel's configuration. An absent field leaves the current value unchanged.
-
social.colibri.channel.update
procedureUpdates a channel's settings.
-
social.colibri.beta.category.create
procedureCreates a category in a community.
-
Renames a category.
-
social.colibri.beta.category
recordA named group of channels within a community.