# chat.bsky.group.requestJoin

> 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.requestJoin)
- [Documentation](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/chat.bsky.group.requestJoin/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:4v4y5r3lwsbtmsxhile2ljac/chat.bsky.group.requestJoin/examples)

## Definitions

### `chat.bsky.group.requestJoin`

**Type**: `procedure`

[NOTE: This is under active development and should be considered unstable while this note is here]. Sends a request to join a group (via join link) to the group owner. Action taken by the prospective group member.

#### Input

**Encoding**: `application/json`

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

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `convo` | `ref` → `chat.bsky.convo.defs#convoView` | No | The group convo joined. This is only present in the case of status=joined |
| `status` | `string` | Yes |  |

#### Errors

- **ConvoLocked**
- **FollowRequired**
- **InvalidCode**
- **LinkDisabled**
- **MemberLimitReached**
- **UserKicked**

## Raw Schema

```json
{
  "id": "chat.bsky.group.requestJoin",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "code"
          ],
          "properties": {
            "code": {
              "type": "string"
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "ConvoLocked"
        },
        {
          "name": "FollowRequired"
        },
        {
          "name": "InvalidCode"
        },
        {
          "name": "LinkDisabled"
        },
        {
          "name": "MemberLimitReached"
        },
        {
          "name": "UserKicked"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "status"
          ],
          "properties": {
            "convo": {
              "ref": "chat.bsky.convo.defs#convoView",
              "type": "ref",
              "description": "The group convo joined. This is only present in the case of status=joined"
            },
            "status": {
              "type": "string",
              "knownValues": [
                "joined",
                "pending"
              ]
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "[NOTE: This is under active development and should be considered unstable while this note is here]. Sends a request to join a group (via join link) to the group owner. Action taken by the prospective group member."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```