# social.colibri.beta.community.update

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

## Definitions

### `social.colibri.beta.community.update`

**Type**: `procedure`

Updates a community's settings. A field left absent stays unchanged.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | No | The community's name. |
| `labelers` | `array` | No | DIDs whose labels this community honours. |
| `community` | `string` (did) | Yes | The community to update. |
| `linkEmbeds` | `boolean` | No | Whether link previews are shown by default. |
| `description` | `string` | No | The community's description. |
| `requiresApprovalToJoin` | `boolean` | No | Whether joining produces an application to approve. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `community` | `ref` → `social.colibri.beta.community.defs#communityView` | Yes | The updated community. |

#### Errors

- **AuthRequired**: The request is missing, malformed, or unverifiable service auth.
- **Forbidden**: The requesting user lacks the community.manage permission.
- **CommunityNotFound**: No community exists with that DID.
- **CredentialsUnavailable**: The AppView's stored credentials for this community are missing or unusable.
- **UpstreamFailure**: A PDS or third-party call the AppView depends on failed.

## Raw Schema

```json
{
  "id": "social.colibri.beta.community.update",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "community"
          ],
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 32,
              "minLength": 1,
              "description": "The community's name."
            },
            "labelers": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "did",
                "description": "A labeler."
              },
              "description": "DIDs whose labels this community honours."
            },
            "community": {
              "type": "string",
              "format": "did",
              "description": "The community to update."
            },
            "linkEmbeds": {
              "type": "boolean",
              "description": "Whether link previews are shown by default."
            },
            "description": {
              "type": "string",
              "maxLength": 256,
              "description": "The community's description."
            },
            "requiresApprovalToJoin": {
              "type": "boolean",
              "description": "Whether joining produces an application to approve."
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthRequired",
          "description": "The request is missing, malformed, or unverifiable service auth."
        },
        {
          "name": "Forbidden",
          "description": "The requesting user lacks the community.manage permission."
        },
        {
          "name": "CommunityNotFound",
          "description": "No community exists with that DID."
        },
        {
          "name": "CredentialsUnavailable",
          "description": "The AppView's stored credentials for this community are missing or unusable."
        },
        {
          "name": "UpstreamFailure",
          "description": "A PDS or third-party call the AppView depends on failed."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "community"
          ],
          "properties": {
            "community": {
              "ref": "social.colibri.beta.community.defs#communityView",
              "type": "ref",
              "description": "The updated community."
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Updates a community's settings. A field left absent stays unchanged."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```