place.wisp.v2.privateSite.delete Documentation (EN)

main procedure

Delete an owned private site, its stored files, and all of its share links.

Input

Encodingapplication/json

siteId stringrecord-key Required

A valid record key for AT Protocol repositories.

Output

Encodingapplication/json

deleted boolean Required

No description available.

siteId stringrecord-key Required

A valid record key for AT Protocol repositories.

Errors

AuthenticationRequired

InvalidRequest

NotFound

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": "Delete an owned private site, its stored files, and all of its share links.",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "InvalidRequest"
    },
    {
      "name": "NotFound"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "siteId": {
          "format": "record-key",
          "type": "string"
        }
      },
      "required": [
        "siteId"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "deleted": {
          "const": true,
          "type": "boolean"
        },
        "siteId": {
          "format": "record-key",
          "type": "string"
        }
      },
      "required": [
        "siteId",
        "deleted"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}