# Tenant routes: update, delete

URL: /code/api/tenant/records-update · Id: `page:code/api/tenant/records-update`

> The Tenant Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for [Tenant](/business/nouns/tenant), one group of [Tenant routes](/code/api/tenant).

### Tenant.update
Changes the given properties of a Tenant. [Verb page](/business/nouns/tenant/update?interface=api).

```text
PATCH /{namespace}/tenants/{id}
```

Path: `id`. Body, as JSON: the other inputs. Emits `Tenant.updated`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Tenant. |
| `placement` | `string` | No | Where the Tenant sits in an address: `path` or `host`. |
| `apiVersion` | `string` | No | The API version an unversioned call with this Tenant’s keys answers at; set at creation, moved only by `pin`. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `tenant` | [Tenant](/business/nouns/tenant) | Yes | The Tenant. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X PATCH https://api.sb/leaseline.app/tenants/ten_Bu63f0he26 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"placement":"path"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "tenant": {
    "$id": "https://api.sb/leaseline.app/tenants/ten_Bu63f0he26",
    "$type": "Tenant",
    "placement": "path",
    "apiVersion": "v2"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Tenant.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Tenant.delete
Deletes a Tenant: a soft delete that keeps its history, undone by `Thing.restore`. [Verb page](/business/nouns/tenant/delete?interface=api).

```text
DELETE /{namespace}/tenants/{id}
```

Path: `id`. Emits `Tenant.deleted`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Tenant. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `tenant` | [Tenant](/business/nouns/tenant) | Yes | The Tenant. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X DELETE https://api.sb/leaseline.app/tenants/ten_Bu63f0he26 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "tenant": {
    "$id": "https://api.sb/leaseline.app/tenants/ten_Bu63f0he26",
    "$type": "Tenant",
    "placement": "path",
    "apiVersion": "v2"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Tenant.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```