tools.ozone.moderation.cancelScheduledActions Documentation (EN)

main procedure

Cancel all pending scheduled moderation actions for specified subjects

Input

Encodingapplication/json

comment string Optional

Optional comment describing the reason for cancellation

subjects array Required

Array of DID subjects to cancel scheduled actions for

maxLength: 100 items

Output

Encodingapplication/json

Schema#cancellationResults

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": [
        "subjects"
      ],
      "properties": {
        "comment": {
          "type": "string",
          "description": "Optional comment describing the reason for cancellation"
        },
        "subjects": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "did"
          },
          "maxLength": 100,
          "description": "Array of DID subjects to cancel scheduled actions for"
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "ref": "#cancellationResults",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "description": "Cancel all pending scheduled moderation actions for specified subjects"
}

cancellationResults object

No description available.

Properties

failed array of ref#failedCancellation Required

DIDs for which cancellation failed with error details

succeeded array of stringdid Required

DIDs for which all pending scheduled actions were successfully cancelled

View raw schema

{
  "type": "object",
  "required": [
    "succeeded",
    "failed"
  ],
  "properties": {
    "failed": {
      "type": "array",
      "items": {
        "ref": "#failedCancellation",
        "type": "ref"
      },
      "description": "DIDs for which cancellation failed with error details"
    },
    "succeeded": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "did"
      },
      "description": "DIDs for which all pending scheduled actions were successfully cancelled"
    }
  }
}

failedCancellation object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

error string Required

No description available.

errorCode string Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "error"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "error": {
      "type": "string"
    },
    "errorCode": {
      "type": "string"
    }
  }
}