# social.colibri.channel

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

## Definitions

### `social.colibri.channel`

**Type**: `record`

A channel that belongs to a category on Colibri.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | The name of the channel. |
| `type` | `string` (nsid) | Yes | The type of the channel. Colibri provides social.colibri.channel.text, social.colibri.channel.forum, social.colibri.channel.link, and social.colibri.channel.voice. |
| `$type` | `string` (nsid) | No | The type of the record. |
| `category` | `string` (record-key) | Yes | The category this channel belongs to. |
| `community` | `string` (record-key) | Yes | The record key of the community this channel belongs to. |
| `ownerOnly` | `boolean` | No | Whether the owner of the community is the only one allowed to post in the channel or not. |
| `description` | `string` | No | A description of the channel. |

## Raw Schema

```json
{
  "id": "social.colibri.channel",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "type",
          "category",
          "community"
        ],
        "properties": {
          "name": {
            "type": "string",
            "default": "New channel",
            "maxLength": 32,
            "minLength": 1,
            "description": "The name of the channel."
          },
          "type": {
            "type": "string",
            "format": "nsid",
            "description": "The type of the channel. Colibri provides social.colibri.channel.text, social.colibri.channel.forum, social.colibri.channel.link, and social.colibri.channel.voice."
          },
          "$type": {
            "type": "string",
            "format": "nsid",
            "description": "The type of the record."
          },
          "category": {
            "type": "string",
            "format": "record-key",
            "description": "The category this channel belongs to."
          },
          "community": {
            "type": "string",
            "format": "record-key",
            "description": "The record key of the community this channel belongs to."
          },
          "ownerOnly": {
            "type": "boolean",
            "default": false,
            "description": "Whether the owner of the community is the only one allowed to post in the channel or not."
          },
          "description": {
            "type": "string",
            "default": "",
            "maxLength": 256,
            "description": "A description of the channel."
          }
        }
      },
      "description": "A channel that belongs to a category on Colibri."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 2
}
```