com.atproto.server.createInviteCodes Documentation (EN)

main procedure

Create invite codes.

Input

Encodingapplication/json

codeCount integer Required

No description available.

forAccounts array Optional

No description available.

useCount integer Required

No description available.

Output

Encodingapplication/json

codes array 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 invite codes.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "codeCount": {
          "default": 1,
          "type": "integer"
        },
        "forAccounts": {
          "items": {
            "format": "did",
            "type": "string"
          },
          "type": "array"
        },
        "useCount": {
          "type": "integer"
        }
      },
      "required": [
        "codeCount",
        "useCount"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "codes": {
          "items": {
            "ref": "#accountCodes",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "codes"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

accountCodes object

No description available.

Properties

account string Required

No description available.

codes array of string Required

No description available.

View raw schema

{
  "properties": {
    "account": {
      "type": "string"
    },
    "codes": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "account",
    "codes"
  ],
  "type": "object"
}