# chat.bsky.group.createJoinLink

> Published by [bsky-lexicons.bsky.social](https://lexicon.garden/identity/did:plc:4v4y5r3lwsbtmsxhile2ljac)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/chat.bsky.group.createJoinLink)
- [Documentation](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/chat.bsky.group.createJoinLink/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/chat.bsky.group.createJoinLink/examples)

## Definitions

### `chat.bsky.group.createJoinLink`

**Type**: `procedure`

[NOTE: This is under active development and should be considered unstable while this note is here]. Creates a join link for the group convo.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `convoId` | `string` | Yes |  |
| `joinRule` | `ref` → `chat.bsky.group.defs#joinRule` | Yes |  |
| `requireApproval` | `boolean` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `joinLink` | `ref` → `chat.bsky.group.defs#joinLinkView` | Yes |  |

#### Errors

- **EnabledJoinLinkAlreadyExists**
- **InvalidConvo**
- **InsufficientRole**

## Raw Schema

```json
{
  "id": "chat.bsky.group.createJoinLink",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "convoId",
            "joinRule"
          ],
          "properties": {
            "convoId": {
              "type": "string"
            },
            "joinRule": {
              "ref": "chat.bsky.group.defs#joinRule",
              "type": "ref"
            },
            "requireApproval": {
              "type": "boolean",
              "default": false
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "EnabledJoinLinkAlreadyExists"
        },
        {
          "name": "InvalidConvo"
        },
        {
          "name": "InsufficientRole"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "joinLink"
          ],
          "properties": {
            "joinLink": {
              "ref": "chat.bsky.group.defs#joinLinkView",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "[NOTE: This is under active development and should be considered unstable while this note is here]. Creates a join link for the group convo."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```