com.atproto.server.createInviteCode Documentation (EN)

main procedure

Create an invite code.

Input

Encodingapplication/json

forAccount stringdid Optional

A decentralized identifier (DID).

useCount integer Required

No description available.

Output

Encodingapplication/json

code string Required

No description available.

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

{
  "description": "Create an invite code.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "forAccount": {
          "format": "did",
          "type": "string"
        },
        "useCount": {
          "type": "integer"
        }
      },
      "required": [
        "useCount"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "code": {
          "type": "string"
        }
      },
      "required": [
        "code"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}