pub.chive.sync.deleteRecord Documentation (EN)

main procedure

Mark a record as deleted in Chive's index (owner or admin only)

Input

Encodingapplication/json

uri stringat-uri Required

AT-URI of the record to mark as deleted

Output

Encodingapplication/json

deleted boolean Required

Whether deletion succeeded

error string Optional

Error message (if failed)

uri stringat-uri Required

AT-URI of the deleted record

Errors

InvalidRequest

AuthenticationRequired

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

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "uri"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the record to mark as deleted"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidRequest"
    },
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "deleted"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the deleted record"
        },
        "error": {
          "type": "string",
          "description": "Error message (if failed)"
        },
        "deleted": {
          "type": "boolean",
          "description": "Whether deletion succeeded"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Mark a record as deleted in Chive's index (owner or admin only)"
}