social.colibri.beta.notification.clear

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.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authoritynotification.beta.colibri.social
Indexed
cid bafyreicqh5xhd5e2azcizb7alyed2qa25alrsrb6gzpmujfmhkf2ejbt2i

Checks

Valid Lint pass
JSONDownload
{
  "$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
}