# ai.newnal.illi.home.join

> Published by [illi-service.newnal.id](https://lexicon.garden/identity/did:plc:uztm7bi2ce42dez3uu3qafro)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.home.join)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.home.join/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uztm7bi2ce42dez3uu3qafro/ai.newnal.illi.home.join/examples)

## Definitions

### `ai.newnal.illi.home.join`

**Type**: `procedure`

Join a home with an invite token as a member (no approval step).

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `displayName` | `string` | Yes |  |
| `photo` | `blob` | No |  |
| `relationship` | `string` | Yes |  |
| `token` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `homeId` | `string` (tid) | Yes |  |
| `role` | `string` | Yes |  |

#### Errors

- **InvalidInvite**
- **InviteExpired**
- **InviteUsedUp**
- **AlreadyMember**
- **RateLimitExceeded**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Join a home with an invite token as a member (no approval step).",
      "errors": [
        {
          "name": "InvalidInvite"
        },
        {
          "name": "InviteExpired"
        },
        {
          "name": "InviteUsedUp"
        },
        {
          "name": "AlreadyMember"
        },
        {
          "name": "RateLimitExceeded"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "displayName": {
              "maxLength": 64,
              "type": "string"
            },
            "photo": {
              "accept": [
                "image/*"
              ],
              "maxSize": 5000000,
              "type": "blob"
            },
            "relationship": {
              "maxLength": 32,
              "type": "string"
            },
            "token": {
              "type": "string"
            }
          },
          "required": [
            "token",
            "displayName",
            "relationship"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "homeId": {
              "format": "tid",
              "type": "string"
            },
            "role": {
              "knownValues": [
                "member"
              ],
              "type": "string"
            }
          },
          "required": [
            "homeId",
            "role"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "ai.newnal.illi.home.join",
  "lexicon": 1
}
```