social.colibri.beta.community.join

colibri.social

Documentation

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.

main procedure

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.

Input

Encodingapplication/json
community stringdid Required

The community to join.

invitation string Optional

An invitation code.

Output

Encodingapplication/json
status string Required

The result of the join attempt.

Known values: joined, pending

Errors

AuthRequired The request is missing, malformed, or unverifiable service auth.
CommunityNotFound No community exists with that DID.
InvitationNotFound No invitation exists with that code.
AlreadyMember The requesting user already holds a member record in this community.
Banned The requesting user is banned from this community.
CredentialsUnavailable The AppView's stored credentials for this community 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"
      ],
      "properties": {
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community to join."
        },
        "invitation": {
          "type": "string",
          "description": "An invitation code."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request is missing, malformed, or unverifiable service auth."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community exists with that DID."
    },
    {
      "name": "InvitationNotFound",
      "description": "No invitation exists with that code."
    },
    {
      "name": "AlreadyMember",
      "description": "The requesting user already holds a member record in this community."
    },
    {
      "name": "Banned",
      "description": "The requesting user is banned from this community."
    },
    {
      "name": "CredentialsUnavailable",
      "description": "The AppView's stored credentials for this community are missing or unusable."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "member": {
          "ref": "social.colibri.beta.community.defs#memberView",
          "type": "ref",
          "description": "The new member view. Present only when status is joined."
        },
        "status": {
          "type": "string",
          "description": "The result of the join attempt.",
          "knownValues": [
            "joined",
            "pending"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "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."
}

Lexicon Garden

@