social.colibri.beta.category.create

colibri.social

Documentation

Creates a category in a community.

main procedure

Creates a category in a community.

Input

Encodingapplication/json
community stringdid Required

The community to create the category in.

name string Required

The category's name.

maxLength: 32 bytesminLength: 1 bytes

Output

Encodingapplication/json

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
Forbidden The caller lacks the category.create permission.
CommunityNotFound No community exists at the given DID.
CredentialsUnavailable The AppView cannot act as the community because its stored credentials are missing or unusable.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "community",
        "name"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 32,
          "minLength": 1,
          "description": "The category's name."
        },
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community to create the category in."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "Forbidden",
      "description": "The caller lacks the category.create permission."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists at the given DID."
    },
    {
      "name": "CredentialsUnavailable",
      "description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "category"
      ],
      "properties": {
        "category": {
          "ref": "social.colibri.beta.community.defs#categoryView",
          "type": "ref",
          "description": "The newly created category."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Creates a category in a community."
}

Lexicon Garden

@