chat.bsky.group.requestJoin Documentation (EN)

main procedure

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

Input

Encodingapplication/json

code string Required

No description available.

Output

Encodingapplication/json

convo refchat.bsky.convo.defs#convoView Optional

The group convo joined. This is only present in the case of status=joined

status string Required

No description available.

Known values: joined, pending

Errors

ConvoLocked

FollowRequired

InvalidCode

LinkDisabled

MemberLimitReached

UserKicked

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "code": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "ConvoLocked"
    },
    {
      "name": "FollowRequired"
    },
    {
      "name": "InvalidCode"
    },
    {
      "name": "LinkDisabled"
    },
    {
      "name": "MemberLimitReached"
    },
    {
      "name": "UserKicked"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "status"
      ],
      "properties": {
        "convo": {
          "ref": "chat.bsky.convo.defs#convoView",
          "type": "ref",
          "description": "The group convo joined. This is only present in the case of status=joined"
        },
        "status": {
          "type": "string",
          "knownValues": [
            "joined",
            "pending"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Sends a request to join a group (via join link) to the group owner. Action taken by the prospective group member."
}