# social.colibri.beta.notification.clear

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.notification.clear)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.notification.clear/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.notification.clear/examples)

## Definitions

### `social.colibri.beta.notification.clear`

**Type**: `procedure`

Clears the requesting user's inbox up to a point in time. Every notification raised at or before it is marked seen and left out of listNotifications, getUnreadCount and getUnseen from then on.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `clearedAt` | `string` (datetime) | Yes | Notifications raised at or before this time are cleared. A time in the future is treated as now, and a time before an earlier clear leaves that clear in place. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `clearedAt` | `string` (datetime) | Yes | The point the inbox is now cleared up to. |
| `unread` | `integer` | Yes | Number of unread notifications remaining. |

#### Errors

- **AuthRequired**: The request has no valid service auth.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Clears the requesting user's inbox up to a point in time. Every notification raised at or before it is marked seen and left out of listNotifications, getUnreadCount and getUnseen from then on.",
      "errors": [
        {
          "description": "The request has no valid service auth.",
          "name": "AuthRequired"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "clearedAt": {
              "description": "Notifications raised at or before this time are cleared. A time in the future is treated as now, and a time before an earlier clear leaves that clear in place.",
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "clearedAt"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "clearedAt": {
              "description": "The point the inbox is now cleared up to.",
              "format": "datetime",
              "type": "string"
            },
            "unread": {
              "description": "Number of unread notifications remaining.",
              "type": "integer"
            }
          },
          "required": [
            "clearedAt",
            "unread"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.beta.notification.clear",
  "lexicon": 1
}
```