# place.wisp.v2.domain.addSite

> 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.addSite)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.addSite/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7puq73yz2hkvbcpdhnsze2qw/place.wisp.v2.domain.addSite/examples)

## Definitions

### `place.wisp.v2.domain.addSite`

**Type**: `procedure`

Map an owned domain to one owned site record.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domain` | `string` | Yes | Fully-qualified domain to map. |
| `siteRkey` | `string` (record-key) | Yes | Owned place.wisp.fs record key to map this domain to. |

#### Output

**Encoding**: `application/json`

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

#### Errors

- **AuthenticationRequired**
- **InvalidDomain**
- **InvalidRequest**
- **NotFound**

## Raw Schema

```json
{
  "id": "place.wisp.v2.domain.addSite",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "domain",
            "siteRkey"
          ],
          "properties": {
            "domain": {
              "type": "string",
              "maxLength": 253,
              "minLength": 3,
              "description": "Fully-qualified domain to map."
            },
            "siteRkey": {
              "type": "string",
              "format": "record-key",
              "description": "Owned place.wisp.fs record key to map this domain to."
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "InvalidDomain"
        },
        {
          "name": "InvalidRequest"
        },
        {
          "name": "NotFound"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "domain",
            "kind",
            "status",
            "siteRkey",
            "mapped"
          ],
          "properties": {
            "kind": {
              "enum": [
                "wisp",
                "custom"
              ],
              "type": "string"
            },
            "domain": {
              "type": "string"
            },
            "mapped": {
              "type": "boolean",
              "const": true
            },
            "status": {
              "enum": [
                "pendingVerification",
                "verified"
              ],
              "type": "string"
            },
            "siteRkey": {
              "type": "string",
              "format": "record-key"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Map an owned domain to one owned site record."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```