social.colibri.beta.actor.putSettings

colibri.social

Documentation

Pushes the requesting user's social.colibri.beta.actor.settings record to the AppView, so it takes effect immediately instead of waiting for a sync notification. The client writes the record to its own personal space first, then calls this. An absent field leaves the current value unchanged.

main procedure

Pushes the requesting user's social.colibri.beta.actor.settings record to the AppView, so it takes effect immediately instead of waiting for a sync notification. The client writes the record to its own personal space first, then calls this. An absent field leaves the current value unchanged.

Input

Encodingapplication/json
communityOrder array Optional

Communities in preferred sidebar order. Absent leaves the current value unchanged.

gifFavorites array Optional

GIFs saved from the picker, stored whole. Absent leaves the current value unchanged.

notificationLevel string Optional

Which messages produce a notification. Absent leaves the current value unchanged.

Output

Encodingapplication/json

Errors

AuthRequired The request has no valid service auth.
InvalidRequest A field is present but does not hold an allowed value.
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": {
        "gifFavorites": {
          "type": "array",
          "items": {
            "ref": "social.colibri.beta.embed.defs#gifView",
            "type": "ref"
          },
          "description": "GIFs saved from the picker, stored whole. Absent leaves the current value unchanged."
        },
        "communityOrder": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "did",
            "description": "A community."
          },
          "description": "Communities in preferred sidebar order. Absent leaves the current value unchanged."
        },
        "notificationLevel": {
          "type": "string",
          "description": "Which messages produce a notification. Absent leaves the current value unchanged.",
          "knownValues": [
            "all",
            "mentionsAndReplies"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "The request has no valid service auth."
    },
    {
      "name": "InvalidRequest",
      "description": "A field is present but does not hold an allowed value."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "preferences"
      ],
      "properties": {
        "preferences": {
          "ref": "social.colibri.beta.actor.defs#preferences",
          "type": "ref",
          "description": "The requesting user's settings, after the update."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Pushes the requesting user's social.colibri.beta.actor.settings record to the AppView, so it takes effect immediately instead of waiting for a sync notification. The client writes the record to its own personal space first, then calls this. An absent field leaves the current value unchanged."
}

Lexicon Garden

@