app.standard-reader.read Documentation (EN)

main record

Marks a site.standard.document as read by the reader. Presence of the record means read; deleting it marks the article unread again.

Record Key any Any valid record key

Properties

createdAt string datetime Required

When the reader opened / marked the article read.

subject string at-uri Required

AT URI of the site.standard.document record that was read.

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "subject",
      "createdAt"
    ],
    "properties": {
      "subject": {
        "type": "string",
        "format": "at-uri",
        "description": "AT URI of the site.standard.document record that was read."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the reader opened / marked the article read."
      }
    }
  },
  "description": "Marks a site.standard.document as read by the reader. Presence of the record means read; deleting it marks the article unread again."
}