social.colibri.actor.setState Documentation (EN)

main procedure

Sets the authenticated user's online presence state.

Parameters

state string Required

The presence state to set.

Output

Encodingapplication/json

onlineState string Required

No description available.

Errors

AuthRequired Missing, malformed, or unverifiable service auth.

InvalidState The given state is not one of the accepted values.

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

View raw schema

{
  "type": "procedure",
  "errors": [
    {
      "name": "AuthRequired",
      "description": "Missing, malformed, or unverifiable service auth."
    },
    {
      "name": "InvalidState",
      "description": "The given state is not one of the accepted values."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "onlineState"
      ],
      "properties": {
        "onlineState": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "state"
    ],
    "properties": {
      "state": {
        "type": "string",
        "description": "The presence state to set.",
        "knownValues": [
          "online",
          "away",
          "dnd",
          "offline"
        ]
      }
    }
  },
  "description": "Sets the authenticated user's online presence state."
}