com.getorbyt.community.beginDeletion Documentation (EN)

main procedure

Begins permanent deletion for an unpublished Community and returns the current PDS declaration to delete. Requires authenticated service authorization by the current declaration holder.

Input

Encodingapplication/json

community stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

Output

Encodingapplication/json

changed boolean Required

No description available.

cid stringcid Required

A content identifier (CID) referencing immutable data.

community stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

declarationUri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

publicationState string Required

No description available.

Known values: deleting

Errors

AuthenticationRequired

CommunityNotFound

InsufficientRole

InvalidState

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": [
        "community"
      ],
      "properties": {
        "community": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "CommunityNotFound"
    },
    {
      "name": "InsufficientRole"
    },
    {
      "name": "InvalidState"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "community",
        "declarationUri",
        "cid",
        "publicationState",
        "changed"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "changed": {
          "type": "boolean"
        },
        "community": {
          "type": "string",
          "format": "at-uri"
        },
        "declarationUri": {
          "type": "string",
          "format": "at-uri"
        },
        "publicationState": {
          "type": "string",
          "knownValues": [
            "deleting"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Begins permanent deletion for an unpublished Community and returns the current PDS declaration to delete. Requires authenticated service authorization by the current declaration holder."
}