# Portal routes: update, delete

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

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

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

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

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

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Portal. |
| `path` | `string` | No | Where it is mounted on the Site, `/portal` by default. |
| `tools` | `string[]` | No | Developer tools a keyed Offer adds: `keys`, `usage`, `requests`, `watches`, `version` and `testMode`. |

**Returns**

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

**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/kilnbakery.com/portals/portal_DDBhWh6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path":"/"}'
```

```json
{
  "api": "https://api.sb/kilnbakery.com",
  "portal": {
    "$id": "https://api.sb/kilnbakery.com/portals/portal_DDBhWh6mF5",
    "$type": "Portal",
    "path": "/"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Portal.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}
```

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

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

Path: `id`. Emits `Portal.deleted`.

**Inputs**

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

**Returns**

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

**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/kilnbakery.com/portals/portal_DDBhWh6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/kilnbakery.com",
  "portal": {
    "$id": "https://api.sb/kilnbakery.com/portals/portal_DDBhWh6mF5",
    "$type": "Portal",
    "path": "/"
  },
  "action": {
    "$id": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k",
    "operation": "Portal.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/kilnbakery.com/actions/act_0y76a1jB6k"
  }
}
```