social.colibri.beta.channel.putReadCursors

colibri.social

Documentation

Pushes the requesting user's read cursors for one community to the AppView, so unread counts update immediately instead of waiting for a sync notification. The client writes its social.colibri.beta.channel.read record for the community to its own personal space first, then calls this. Clients should debounce this rather than calling it on every message.

main procedure

Pushes the requesting user's read cursors for one community to the AppView, so unread counts update immediately instead of waiting for a sync notification. The client writes its social.colibri.beta.channel.read record for the community to its own personal space first, then calls this. Clients should debounce this rather than calling it on every message.

Input

Encodingapplication/json
community stringdid Required

The community the cursors belong to.

cursors array Required

The complete, replacement set of read cursors for the community's channels.

Output

Encodingapplication/json
statuses array Required

Unread state per channel, after the update.

Errors

AuthRequired The request has no valid service auth.
CommunityNotFound No community matches the given DID.
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": [
        "community",
        "cursors"
      ],
      "properties": {
        "cursors": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.channel.read#cursor",
            "type": "ref"
          },
          "description": "The complete, replacement set of read cursors for the community's channels."
        },
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community the cursors belong to."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "CommunityNotFound",
      "description": "No community matches the given DID."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "statuses"
      ],
      "properties": {
        "statuses": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.channel.defs#unreadStatus",
            "type": "ref"
          },
          "description": "Unread state per channel, after the update."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Pushes the requesting user's read cursors for one community to the AppView, so unread counts update immediately instead of waiting for a sync notification. The client writes its social.colibri.beta.channel.read record for the community to its own personal space first, then calls this. Clients should debounce this rather than calling it on every message."
}

Lexicon Garden

@