town.delve.membership.join

delve.town

Documentation

Join the town, or rejoin after withdrawing. An account hosted on the town's own PDS needs no code; any other account presents an invite code: either a town invite or a code a member took from Settings on the town's PDS, which the join then spends. Requires auth.

main procedure

Join the town, or rejoin after withdrawing. An account hosted on the town's own PDS needs no code; any other account presents an invite code: either a town invite or a code a member took from Settings on the town's PDS, which the join then spends. Requires auth.

Input

Encodingapplication/json
inviteCode string Optional

No description available.

maxLength: 128 bytes
revision integer Optional

The membership revision the caller last saw; the join fails with MembershipChanged if it moved.

Output

Encodingapplication/json

Errors

InvalidInvite No valid invite for this account: missing, expired, spent, disabled, or bound to another account.
MembershipSuspended
MembershipChanged
MembershipDisabled This AppView does not admit accounts by membership.
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 
{
  "description": "Join the town, or rejoin after withdrawing. An account hosted on the town's own PDS needs no code; any other account presents an invite code: either a town invite or a code a member took from Settings on the town's PDS, which the join then spends. Requires auth.",
  "errors": [
    {
      "description": "No valid invite for this account: missing, expired, spent, disabled, or bound to another account.",
      "name": "InvalidInvite"
    },
    {
      "name": "MembershipSuspended"
    },
    {
      "name": "MembershipChanged"
    },
    {
      "description": "This AppView does not admit accounts by membership.",
      "name": "MembershipDisabled"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "inviteCode": {
          "maxLength": 128,
          "type": "string"
        },
        "revision": {
          "description": "The membership revision the caller last saw; the join fails with MembershipChanged if it moved.",
          "type": "integer"
        }
      },
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "membership": {
          "ref": "town.delve.membership.defs#membership",
          "type": "ref"
        }
      },
      "required": [
        "membership"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@