ai.newnal.illi.home.createInvite Documentation (EN)

main procedure

Create an invite link (root admin). The token is shown once and delivered by hand.

Input

Encodingapplication/json

expiresInDays integer Optional

No description available.

minimum: 1maximum: 30

homeId stringtid Required

A timestamp-based identifier (TID).

maxUses integer Optional

No description available.

minimum: 1maximum: 20

note string Optional

No description available.

maxLength: 120 bytes

Output

Encodingapplication/json

expiresAt stringdatetime Required

An RFC 3339 formatted timestamp.

inviteId string Required

No description available.

inviteUrl stringuri Required

A valid URI.

maxUses integer Required

No description available.

Errors

NotRootAdmin

HomeNotFound

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": "Create an invite link (root admin). The token is shown once and delivered by hand.",
  "errors": [
    {
      "name": "NotRootAdmin"
    },
    {
      "name": "HomeNotFound"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "expiresInDays": {
          "default": 7,
          "maximum": 30,
          "minimum": 1,
          "type": "integer"
        },
        "homeId": {
          "format": "tid",
          "type": "string"
        },
        "maxUses": {
          "default": 1,
          "maximum": 20,
          "minimum": 1,
          "type": "integer"
        },
        "note": {
          "maxLength": 120,
          "type": "string"
        }
      },
      "required": [
        "homeId"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "expiresAt": {
          "format": "datetime",
          "type": "string"
        },
        "inviteId": {
          "type": "string"
        },
        "inviteUrl": {
          "format": "uri",
          "type": "string"
        },
        "maxUses": {
          "type": "integer"
        }
      },
      "required": [
        "inviteId",
        "inviteUrl",
        "expiresAt",
        "maxUses"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}