# social.colibri.beta.actor.setStatus

> 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.beta.actor.setStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.actor.setStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.actor.setStatus/examples)

## Definitions

### `social.colibri.beta.actor.setStatus`

**Type**: `procedure`

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

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `text` | `string` | No | The status text. Absent leaves the current value unchanged. |
| `emoji` | `string` | No | An emoji shown beside the status. Absent leaves the current value unchanged. |
| `onlineState` | `string` | No | Derived online state. Absent leaves the current value unchanged. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `presence` | `ref` → `social.colibri.beta.actor.defs#presence` | Yes | The requesting user's presence, after the update. |

#### Errors

- **AuthRequired**: The request has no valid service auth.
- **InvalidRequest**: A field is present but does not hold an allowed value.

## Raw Schema

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