ai.newnal.illi.home.join

illi-service.newnal.id

Documentation

Join a home with an invite token as a member (no approval step).

main procedure

Join a home with an invite token as a member (no approval step).

Input

Encodingapplication/json
displayName string Required

No description available.

maxLength: 64 bytes
photo blob Optional

No description available.

maxSize: 5.0 MB
relationship string Required

No description available.

maxLength: 32 bytes
token string Required

No description available.

Output

Encodingapplication/json
homeId stringtid Required

A timestamp-based identifier (TID).

role string Required

No description available.

Known values: member

Errors

InvalidInvite
InviteExpired
InviteUsedUp
AlreadyMember
RateLimitExceeded
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 a home with an invite token as a member (no approval step).",
  "errors": [
    {
      "name": "InvalidInvite"
    },
    {
      "name": "InviteExpired"
    },
    {
      "name": "InviteUsedUp"
    },
    {
      "name": "AlreadyMember"
    },
    {
      "name": "RateLimitExceeded"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "displayName": {
          "maxLength": 64,
          "type": "string"
        },
        "photo": {
          "accept": [
            "image/*"
          ],
          "maxSize": 5000000,
          "type": "blob"
        },
        "relationship": {
          "maxLength": 32,
          "type": "string"
        },
        "token": {
          "type": "string"
        }
      },
      "required": [
        "token",
        "displayName",
        "relationship"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "homeId": {
          "format": "tid",
          "type": "string"
        },
        "role": {
          "knownValues": [
            "member"
          ],
          "type": "string"
        }
      },
      "required": [
        "homeId",
        "role"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@