social.colibri.beta.notification.updateSeenForMessage

colibri.social

Documentation

Marks the notifications raised by one message seen.

main procedure

Marks the notifications raised by one message seen.

Input

Encodingapplication/json
channel stringspace-ref Required

The channel the message was posted in.

Output

Encodingapplication/json
unread integer Required

Number of unread notifications remaining.

Errors

AuthRequired The request has no valid service auth.
ChannelNotFound No channel matches the given space reference.
MessageNotFound No message matches the given record reference in that channel.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "channel",
        "message"
      ],
      "properties": {
        "channel": {
          "type": "string",
          "format": "space-ref",
          "description": "The channel the message was posted in."
        },
        "message": {
          "ref": "social.colibri.beta.defs#recordRef",
          "type": "ref",
          "description": "The message whose notifications are marked seen."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "ChannelNotFound",
      "description": "No channel matches the given space reference."
    },
    {
      "name": "MessageNotFound",
      "description": "No message matches the given record reference in that channel."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "unread"
      ],
      "properties": {
        "unread": {
          "type": "integer",
          "description": "Number of unread notifications remaining."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Marks the notifications raised by one message seen."
}

Lexicon Garden

@