# social.colibri.community

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

## Definitions

### `social.colibri.community`

**Type**: `record`

A community, or "server", is where users join to interact with each other on Colibri.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | The name of the community. |
| `$type` | `string` (nsid) | No | The type of the record. |
| `picture` | `blob` | No | An image for the community that will be shown to users. |
| `description` | `string` | Yes | A description of the community. |
| `categoryOrder` | `array` | Yes | The order of the categories in this community. |
| `requiresApprovalToJoin` | `boolean` | Yes | Whether users can chat in this community without the owner having to create an acknowledgement record. |

## Raw Schema

```json
{
  "id": "social.colibri.community",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "description",
          "categoryOrder",
          "requiresApprovalToJoin"
        ],
        "properties": {
          "name": {
            "type": "string",
            "default": "New Community",
            "maxLength": 32,
            "minLength": 1,
            "description": "The name of the community."
          },
          "$type": {
            "type": "string",
            "format": "nsid",
            "description": "The type of the record."
          },
          "picture": {
            "type": "blob",
            "accept": [
              "image/jpeg",
              "image/png",
              "image/gif"
            ],
            "description": "An image for the community that will be shown to users."
          },
          "description": {
            "type": "string",
            "default": "",
            "maxLength": 256,
            "description": "A description of the community."
          },
          "categoryOrder": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "record-key",
              "description": "A category in this community."
            },
            "description": "The order of the categories in this community."
          },
          "requiresApprovalToJoin": {
            "type": "boolean",
            "default": true,
            "description": "Whether users can chat in this community without the owner having to create an acknowledgement record."
          }
        }
      },
      "description": "A community, or \"server\", is where users join to interact with each other on Colibri."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```