social.colibri.beta.community.create

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The arguments are inconsistent or malformed beyond schema validation.",
          "name": "InvalidRequest"
        },
        {
          "description": "A community already exists with the requested handle.",
          "name": "AlreadyExists"
        },
        {
          "description": "The AppView's PDS could not be reached to provision the account.",
          "name": "PdsUnavailable"
        },
        {
          "description": "The AppView's PDS does not implement the com.atproto.space policy methods, so it cannot host community spaces.",
          "name": "SpacesUnsupported"
        },
        {
          "description": "A PDS or third-party call the AppView depends on failed.",
          "name": "UpstreamFailure"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "description": {
              "description": "The community's description.",
              "maxLength": 256,
              "type": "string"
            },
            "handlePrefix": {
              "description": "A slug used for the community handle instead of a generated one.",
              "type": "string"
            },
            "name": {
              "description": "The community's name.",
              "maxLength": 32,
              "minLength": 1,
              "type": "string"
            },
            "overrideUserNameColors": {
              "description": "Whether only role colours are shown in chat. Members' own name colours are hidden, and a member without a coloured role shows the default name colour. Defaults to false.",
              "type": "boolean"
            },
            "requiresApprovalToJoin": {
              "description": "Whether joining produces an application a moderator must approve. Defaults to false.",
              "type": "boolean"
            }
          },
          "required": [
            "name"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "description": "The newly created community.",
              "ref": "social.colibri.beta.community.defs#communityView",
              "type": "ref"
            }
          },
          "required": [
            "community"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.beta.community.create",
  "lexicon": 1
}