# blue.catbird.circle.updatePreferences

> Published by [catbird.blue](https://lexicon.garden/identity/did:plc:xg4h4n7w5mh3m4uoi27me4hh)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.updatePreferences)
- [Documentation](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.updatePreferences/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:xg4h4n7w5mh3m4uoi27me4hh/blue.catbird.circle.updatePreferences/examples)

## Definitions

### `blue.catbird.circle.updatePreferences`

**Type**: `procedure`

Update user preferences for a Circle Space

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `muted` | `boolean` | Yes |  |
| `space` | `string` (space-ref) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `muted` | `boolean` | Yes |  |

#### Errors

- **AuthRequired**
- **AccessRemoved**
- **UnsupportedPDS**
- **ProtocolRevisionMismatch**
- **UpstreamUnavailable**

## Raw Schema

```json
{
  "id": "blue.catbird.circle.updatePreferences",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "space",
            "muted"
          ],
          "properties": {
            "muted": {
              "type": "boolean"
            },
            "space": {
              "type": "string",
              "format": "space-ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthRequired"
        },
        {
          "name": "AccessRemoved"
        },
        {
          "name": "UnsupportedPDS"
        },
        {
          "name": "ProtocolRevisionMismatch"
        },
        {
          "name": "UpstreamUnavailable"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "muted"
          ],
          "properties": {
            "muted": {
              "type": "boolean"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Update user preferences for a Circle Space"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```