Lexicon Garden

chat.bsky.group.requestJoin

Sends a request to join a group (via join link) to the group owner. Action taken by the prospective group member.

Repository @bsky-lexicons.bsky.social did:plc:4v4y5r3lwsbtmsxhile2ljac namespace authority
Details · procedure
Kindprocedure
Authoritygroup.bsky.chat
Indexed
Compare Edit in builder → Fork →
cid bafyreiatzqdp7zlnbqmbti6xt3orag7yqyuqr6tqzwzzp52gq7hlu3it6q

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.codeNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.statusNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Sends a request to join a group (via join link) to the group owner. Action taken by the prospective group member.",
      "errors": [
        {
          "name": "ConvoLocked"
        },
        {
          "name": "FollowRequired"
        },
        {
          "name": "InvalidCode"
        },
        {
          "name": "LinkDisabled"
        },
        {
          "name": "MemberLimitReached"
        },
        {
          "name": "UserKicked"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "code": {
              "type": "string"
            }
          },
          "required": [
            "code"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "convo": {
              "description": "The group convo joined. This is only present in the case of status=joined",
              "ref": "chat.bsky.convo.defs#convoView",
              "type": "ref"
            },
            "status": {
              "knownValues": [
                "joined",
                "pending"
              ],
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "chat.bsky.group.requestJoin",
  "lexicon": 1
}