fyi.opensocial.requestJoin Documentation (EN)

main procedure

Ask to join, or redeem an invite. No role required; authenticated as the requester.

Input

Encodingapplication/json

group stringdid Required

The group DID. Every method is served by the group's host and authorized against that group's roles.

invite stringat-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

message string Optional

No description available.

Output

Encodingapplication/json

status string Required

No description available.

Known values: admitted, pending

Errors

InviteRequired

AlreadyMember

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

{
  "description": "Ask to join, or redeem an invite. No role required; authenticated as the requester.",
  "errors": [
    {
      "name": "InviteRequired"
    },
    {
      "name": "AlreadyMember"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "group": {
          "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
          "format": "did",
          "type": "string"
        },
        "invite": {
          "format": "at-uri",
          "type": "string"
        },
        "message": {
          "type": "string"
        }
      },
      "required": [
        "group"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "status": {
          "knownValues": [
            "admitted",
            "pending"
          ],
          "type": "string"
        }
      },
      "required": [
        "status"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}