social.colibri.beta.category.create
Creates a category in a community.
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.
A member permitted to post.
allowedRoles
arrayRoles allowed to post in the category's channels. Empty means no role restriction. A channel that sets its own posting restriction overrides this.
A role permitted to post.
The community to create the category in.
The category's name.
minLength: 1maxLength: 32
ownerOnly
booleanWhether only community admins may post in the category's channels. A channel that sets its own posting restriction overrides this.
visibleToMembers
arrayMembers that may read the category's channels in addition to visibleToRoles.
A member permitted to read.
visibleToRoles
arrayRoles that may read the category's channels. Empty or absent means every member may read them. A channel with its own non-empty visibleToRoles or visibleToMembers overrides this. A non-empty list makes the category's other channels private, enforced the same way as a private channel.
A role permitted to read.
Output
application/jsonThe newly created category.
Errors
AuthRequired
The request is missing, malformed, or unverifiable service auth.
Forbidden
The caller lacks the category.create permission, or grants visibility to a role at or above their own highest position.
CommunityNotFound
No community exists at the given DID.
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.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.create
procedureCreates a channel in a category of a community.
-
Creates a category in a community.
-
social.colibri.beta.category
recordA named group of channels within a community.
-
social.colibri.beta.category.update
procedureUpdates a category's name and the permissions its channels inherit.