social.colibri.beta.actor.setStatus

colibri.social

Documentation

Sets the requesting user's off-protocol presence. An absent field leaves the current value unchanged.

main procedure

Sets the requesting user's off-protocol presence. An absent field leaves the current value unchanged.

Input

Encodingapplication/json
emoji string Optional

An emoji shown beside the status. Absent leaves the current value unchanged.

onlineState string Optional

Derived online state. Absent leaves the current value unchanged.

text string Optional

The status text. Absent leaves the current value unchanged.

maxLength: 32 bytes

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": {
        "text": {
          "type": "string",
          "maxLength": 32,
          "description": "The status text. Absent leaves the current value unchanged."
        },
        "emoji": {
          "type": "string",
          "description": "An emoji shown beside the status. Absent leaves the current value unchanged."
        },
        "onlineState": {
          "type": "string",
          "description": "Derived online state. Absent leaves the current value unchanged.",
          "knownValues": [
            "online",
            "away",
            "dnd",
            "offline"
          ]
        }
      }
    },
    "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": [
        "presence"
      ],
      "properties": {
        "presence": {
          "ref": "social.colibri.beta.actor.defs#presence",
          "type": "ref",
          "description": "The requesting user's presence, after the update."
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Sets the requesting user's off-protocol presence. An absent field leaves the current value unchanged."
}

Lexicon Garden

@