place.wisp.v2.domain.claimSubdomain Documentation (EN)

main procedure

Claim a wisp.place subdomain handle for the authenticated DID.

Input

Encodingapplication/json

handle string Required

Subdomain label only (for example, alice).

maxLength: 63 bytesminLength: 3 bytes

siteRkey stringrecord-key Optional

Optional place.wisp.fs rkey to map immediately after claim.

Output

Encodingapplication/json

domain string Required

No description available.

kind string Required

No description available.

siteRkey stringrecord-key Optional

A valid record key for AT Protocol repositories.

status string Required

No description available.

Errors

AuthenticationRequired

InvalidDomain

AlreadyClaimed

DomainLimitReached

RateLimitExceeded

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

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "handle"
      ],
      "properties": {
        "handle": {
          "type": "string",
          "maxLength": 63,
          "minLength": 3,
          "description": "Subdomain label only (for example, alice)."
        },
        "siteRkey": {
          "type": "string",
          "format": "record-key",
          "description": "Optional place.wisp.fs rkey to map immediately after claim."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "InvalidDomain"
    },
    {
      "name": "AlreadyClaimed"
    },
    {
      "name": "DomainLimitReached"
    },
    {
      "name": "RateLimitExceeded"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "domain",
        "kind",
        "status"
      ],
      "properties": {
        "kind": {
          "enum": [
            "wisp"
          ],
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "status": {
          "enum": [
            "verified",
            "alreadyClaimed"
          ],
          "type": "string"
        },
        "siteRkey": {
          "type": "string",
          "format": "record-key"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Claim a wisp.place subdomain handle for the authenticated DID."
}