social.colibri.beta.category.create

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Creates a category in a community.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller lacks the category.create permission, or grants visibility to a role at or above their own highest position.",
          "name": "Forbidden"
        },
        {
          "description": "No community exists at the given DID.",
          "name": "CommunityNotFound"
        },
        {
          "description": "The AppView cannot act as the community because its stored credentials are missing or unusable.",
          "name": "CredentialsUnavailable"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "allowedMembers": {
              "description": "Members allowed to post in the category's channels in addition to allowedRoles.",
              "items": {
                "description": "A member permitted to post.",
                "format": "did",
                "type": "string"
              },
              "type": "array"
            },
            "allowedRoles": {
              "description": "Roles allowed to post in the category's channels. Empty means no role restriction. A channel that sets its own posting restriction overrides this.",
              "items": {
                "description": "A role permitted to post.",
                "format": "record-key",
                "type": "string"
              },
              "type": "array"
            },
            "community": {
              "description": "The community to create the category in.",
              "format": "did",
              "type": "string"
            },
            "name": {
              "description": "The category's name.",
              "maxLength": 32,
              "minLength": 1,
              "type": "string"
            },
            "ownerOnly": {
              "description": "Whether only community admins may post in the category's channels. A channel that sets its own posting restriction overrides this.",
              "type": "boolean"
            },
            "visibleToMembers": {
              "description": "Members that may read the category's channels in addition to visibleToRoles.",
              "items": {
                "description": "A member permitted to read.",
                "format": "did",
                "type": "string"
              },
              "type": "array"
            },
            "visibleToRoles": {
              "description": "Roles 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.",
              "items": {
                "description": "A role permitted to read.",
                "format": "record-key",
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "community",
            "name"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "category": {
              "description": "The newly created category.",
              "ref": "social.colibri.beta.community.defs#categoryView",
              "type": "ref"
            }
          },
          "required": [
            "category"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.beta.category.create",
  "lexicon": 1
}