# place.wisp.v2.domain.claimSubdomain

> Published by [wisp.place](https://lexicon.garden/identity/did:plc:7puq73yz2hkvbcpdhnsze2qw)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.claimSubdomain)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.claimSubdomain/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.claimSubdomain/examples)

## Definitions

### `place.wisp.v2.domain.claimSubdomain`

**Type**: `procedure`

Claim a wisp.place subdomain handle for the authenticated DID.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `handle` | `string` | Yes | Subdomain label only (for example, alice). |
| `siteRkey` | `string` (record-key) | No | Optional place.wisp.fs rkey to map immediately after claim. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `kind` | `string` | Yes |  |
| `domain` | `string` | Yes |  |
| `status` | `string` | Yes |  |
| `siteRkey` | `string` (record-key) | No |  |

#### Errors

- **AuthenticationRequired**
- **InvalidDomain**
- **AlreadyClaimed**
- **DomainLimitReached**
- **RateLimitExceeded**

## Raw Schema

```json
{
  "id": "place.wisp.v2.domain.claimSubdomain",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "handle"
          ],
          "properties": {
            "handle": {
              "type": "string",
              "maxLength": 63,
              "minLength": 3,
              "description": "Subdomain label only (for example, alice)."
            },
            "siteRkey": {
              "type": "string",
              "format": "record-key",
              "description": "Optional place.wisp.fs rkey to map immediately after claim."
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "InvalidDomain"
        },
        {
          "name": "AlreadyClaimed"
        },
        {
          "name": "DomainLimitReached"
        },
        {
          "name": "RateLimitExceeded"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "domain",
            "kind",
            "status"
          ],
          "properties": {
            "kind": {
              "enum": [
                "wisp"
              ],
              "type": "string"
            },
            "domain": {
              "type": "string"
            },
            "status": {
              "enum": [
                "verified",
                "alreadyClaimed"
              ],
              "type": "string"
            },
            "siteRkey": {
              "type": "string",
              "format": "record-key"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Claim a wisp.place subdomain handle for the authenticated DID."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```