# tools.ozone.moderation.cancelScheduledActions

> Published by [ozone-lexicons.bsky.social](https://lexicon.garden/identity/did:plc:33dt5kftu3jq2h5h4jjlqezt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:33dt5kftu3jq2h5h4jjlqezt/tools.ozone.moderation.cancelScheduledActions)
- [Documentation](https://lexicon.garden/lexicon/did:plc:33dt5kftu3jq2h5h4jjlqezt/tools.ozone.moderation.cancelScheduledActions/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:33dt5kftu3jq2h5h4jjlqezt/tools.ozone.moderation.cancelScheduledActions/examples)

## Definitions

### `tools.ozone.moderation.cancelScheduledActions`

**Type**: `procedure`

Cancel all pending scheduled moderation actions for specified subjects

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `comment` | `string` | No | Optional comment describing the reason for cancellation |
| `subjects` | `array` | Yes | Array of DID subjects to cancel scheduled actions for |

#### Output

**Encoding**: `application/json`

### `tools.ozone.moderation.cancelScheduledActions#failedCancellation`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `error` | `string` | Yes |  |
| `errorCode` | `string` | No |  |

### `tools.ozone.moderation.cancelScheduledActions#cancellationResults`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `failed` | `array` | Yes | DIDs for which cancellation failed with error details |
| `succeeded` | `array` | Yes | DIDs for which all pending scheduled actions were successfully cancelled |

## Raw Schema

```json
{
  "id": "tools.ozone.moderation.cancelScheduledActions",
  "defs": {
    "main": {
      "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"
    },
    "failedCancellation": {
      "type": "object",
      "required": [
        "did",
        "error"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "error": {
          "type": "string"
        },
        "errorCode": {
          "type": "string"
        }
      }
    },
    "cancellationResults": {
      "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"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
