# com.getorbyt.community.checkName

> Published by [getorbyt.com](https://lexicon.garden/identity/did:plc:2xrqztnmzlckb3xfuuukupso)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.community.checkName)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.community.checkName/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.community.checkName/examples)

## Definitions

### `com.getorbyt.community.checkName`

**Type**: `query`

Whether a lowercase Community name is free. Names are globally unique at the AppView, and a record whose name is taken is rejected at projection time rather than at write time, so clients check before writing.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `reason` | `string` | No | Why the name is unavailable. Absent when available. |
| `available` | `boolean` | Yes |  |

## Raw Schema

```json
{
  "id": "com.getorbyt.community.checkName",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "name",
            "available"
          ],
          "properties": {
            "name": {
              "type": "string"
            },
            "reason": {
              "type": "string",
              "description": "Why the name is unavailable. Absent when available.",
              "knownValues": [
                "taken",
                "invalid",
                "reserved"
              ]
            },
            "available": {
              "type": "boolean"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 63,
            "minLength": 2
          }
        }
      },
      "description": "Whether a lowercase Community name is free. Names are globally unique at the AppView, and a record whose name is taken is rejected at projection time rather than at write time, so clients check before writing."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```