social.colibri.beta.community.create

{
  "id": "social.colibri.beta.community.create",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "name"
          ],
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 32,
              "minLength": 1,
              "description": "The community's name."
            },
            "description": {
              "type": "string",
              "maxLength": 256,
              "description": "The community's description."
            },
            "handlePrefix": {
              "type": "string",
              "description": "A slug used for the community handle instead of a generated one."
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthRequired",
          "description": "The request is missing, malformed, or unverifiable service auth."
        },
        {
          "name": "InvalidRequest",
          "description": "The arguments are inconsistent or malformed beyond schema validation."
        },
        {
          "name": "AlreadyExists",
          "description": "A community already exists with the requested handle."
        },
        {
          "name": "PdsUnavailable",
          "description": "The AppView's PDS could not be reached to provision the account."
        },
        {
          "name": "UpstreamFailure",
          "description": "A PDS or third-party call the AppView depends on failed."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "community"
          ],
          "properties": {
            "community": {
              "ref": "social.colibri.beta.community.defs#communityView",
              "type": "ref",
              "description": "The newly created community."
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Provisions a new community: an account on the AppView's PDS, its four spaces, an owner role, and a starter layout of two categories holding one text channel and one voice channel between them. This call runs long enough that progress is also emitted over social.colibri.beta.sync.subscribeEvents."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}