social.colibri.beta.community.join

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Admits the requesting user to a community. Joining is an AppView procedure rather than a record the user writes, because admission is what makes the community's spaces readable to them.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "No community exists with that DID.",
          "name": "CommunityNotFound"
        },
        {
          "description": "No invitation exists with that code.",
          "name": "InvitationNotFound"
        },
        {
          "description": "The requesting user already holds a member record in this community.",
          "name": "AlreadyMember"
        },
        {
          "description": "The requesting user is banned from this community.",
          "name": "Banned"
        },
        {
          "description": "The AppView's stored credentials for this community are missing or unusable.",
          "name": "CredentialsUnavailable"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "description": "The community to join.",
              "format": "did",
              "type": "string"
            },
            "invitation": {
              "description": "An invitation code.",
              "type": "string"
            }
          },
          "required": [
            "community"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "member": {
              "description": "The new member view. Present only when status is joined.",
              "ref": "social.colibri.beta.community.defs#memberView",
              "type": "ref"
            },
            "status": {
              "description": "The result of the join attempt.",
              "knownValues": [
                "joined",
                "pending"
              ],
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.beta.community.join",
  "lexicon": 1
}