app.bivri.actor.putPreferences

lexicons.bivri.app

Documentation

Replace the authenticated account's own preferences. Every group sent is replaced whole and every group omitted is left as it was, so a client that knows about one group cannot silently reset another it has never heard of. Sending the same preferences twice is the same as sending them once. Preferences are the account's alone: nothing here names another account, and nothing here is served to one.

main procedure

Replace the authenticated account's own preferences. Every group sent is replaced whole and every group omitted is left as it was, so a client that knows about one group cannot silently reset another it has never heard of. Sending the same preferences twice is the same as sending them once. Preferences are the account's alone: nothing here names another account, and nothing here is served to one.

Input

Encodingapplication/json

Output

Encodingapplication/json

Errors

Unauthenticated Nobody is authenticated, so there are no preferences to replace.
InvalidInput The request body is not an object, names a preference group that is not an object, names a reason this service does not have, or omits one it does. Nothing was stored.
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",
      "properties": {
        "notifications": {
          "ref": "app.bivri.actor.defs#notificationPreferences",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "Unauthenticated",
      "description": "Nobody is authenticated, so there are no preferences to replace."
    },
    {
      "name": "InvalidInput",
      "description": "The request body is not an object, names a preference group that is not an object, names a reason this service does not have, or omits one it does. Nothing was stored."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "notifications"
      ],
      "properties": {
        "notifications": {
          "ref": "app.bivri.actor.defs#notificationPreferences",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Replace the authenticated account's own preferences. Every group sent is replaced whole and every group omitted is left as it was, so a client that knows about one group cannot silently reset another it has never heard of. Sending the same preferences twice is the same as sending them once. Preferences are the account's alone: nothing here names another account, and nothing here is served to one."
}

Lexicon Garden

@