social.coves.aggregator.disable Documentation (EN)

main procedure

Disable an aggregator for a community. Updates the authorization record to set enabled=false. Requires moderator permissions.

Input

Encodingapplication/json

aggregatorDid stringdid Required

DID of the aggregator to disable

community stringat-identifier Required

DID or handle of the community

Output

Encodingapplication/json

cid stringcid Required

CID of the updated authorization record

disabledAt stringdatetime Optional

When the aggregator was disabled

uri stringat-uri Required

AT-URI of the updated authorization record

Errors

NotAuthorized Caller is not a moderator of this community

AuthorizationNotFound Aggregator is not enabled for this community

AlreadyDisabled Aggregator is already disabled

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",
        "aggregatorDid"
      ],
      "properties": {
        "community": {
          "type": "string",
          "format": "at-identifier",
          "description": "DID or handle of the community"
        },
        "aggregatorDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the aggregator to disable"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "NotAuthorized",
      "description": "Caller is not a moderator of this community"
    },
    {
      "name": "AuthorizationNotFound",
      "description": "Aggregator is not enabled for this community"
    },
    {
      "name": "AlreadyDisabled",
      "description": "Aggregator is already disabled"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "CID of the updated authorization record"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the updated authorization record"
        },
        "disabledAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the aggregator was disabled"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Disable an aggregator for a community. Updates the authorization record to set enabled=false. Requires moderator permissions."
}