# social.colibri.actor.setState

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.setState)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.setState/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.setState/examples)

## Definitions

### `social.colibri.actor.setState`

**Type**: `procedure`

Sets the authenticated user's online presence state.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `onlineState` | `string` | Yes |  |

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.
- **InvalidState**: The given state is not one of the accepted values.

## Raw Schema

```json
{
  "id": "social.colibri.actor.setState",
  "defs": {
    "main": {
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```