# social.colibri.community.createInvitation

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.community.createInvitation)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.community.createInvitation/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.community.createInvitation/examples)

## Definitions

### `social.colibri.community.createInvitation`

**Type**: `procedure`

Creates an invitation code for a community.

#### Output

**Encoding**: `application/json`

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.
- **Forbidden**: The caller lacks the permission this method requires.
- **InvalidRequest**: A parameter or body field was missing or malformed.
- **NotFound**: The referenced record does not exist.

## Raw Schema

```json
{
  "id": "social.colibri.community.createInvitation",
  "defs": {
    "main": {
      "type": "procedure",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "Missing, malformed, or unverifiable service auth."
        },
        {
          "name": "Forbidden",
          "description": "The caller lacks the permission this method requires."
        },
        {
          "name": "InvalidRequest",
          "description": "A parameter or body field was missing or malformed."
        },
        {
          "name": "NotFound",
          "description": "The referenced record does not exist."
        }
      ],
      "output": {
        "schema": {
          "ref": "lex:social.colibri.community.defs#invitationView",
          "type": "ref"
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "community"
        ],
        "properties": {
          "community": {
            "type": "string",
            "format": "at-uri"
          }
        }
      },
      "description": "Creates an invitation code for a community."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```