> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/outbound-site/openapi.json](/docs/api/outbound-site/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Outbound domain pages: Update the outbound site

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

One endpoint of [Outbound domain pages](/docs/api/outbound-site.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Update the outbound site

`PATCH /v1/outbound-site` - operationId `outbound-site.update`

| Permission | Rate limit |
| --- | --- |
| Delivery edit | 4,800 requests a minute per API key |

Changes the details the outbound site page shows. Send only the fields you want to change: a field you leave out
keeps its value, and null or an empty string clears a text field. The first update creates the outbound site.

`mainSiteUrl` is a public http or https URL of at most 2,048 characters. `brandName` and
`legalName` are at most 200 characters, `contactEmail` is one email address, `postalAddress` is at
most 500 characters, and `showMainSiteLink` is true or false. Before it saves, Kenso runs its link
reputation check on the website the page will link to: `mainSiteUrl`, else the workspace website.

When a version is live, every domain that shows the page updates at once, with no rebuild. Example:
`{"contactEmail": "hello@acme.com", "showMainSiteLink": false}`.

Errors:

- `400 validation_failed`: a field breaks a rule, or the linked website fails the reputation check. The error
has one detail per field, and nothing is saved.
- `503 service_unavailable`: the change was saved but the live page did not update. Send the same request
again.

Requires Delivery edit.

Needs the `domain_pages` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/outbound-site/PATCH/v1/outbound-site)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Request body

`application/json`, optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `mainSiteUrl` | string | no | The website the page links to and is rebuilt from: a public http or https URL of at most 2,048 characters. Null makes the page use the workspace website. |
| `brandName` | string | no | The brand name the page shows, at most 200 characters. |
| `contactEmail` | string | no | The public contact email the page shows, one address such as `hello@acme.com`. |
| `legalName` | string | no | The company's legal name for the page footer, at most 200 characters. |
| `postalAddress` | string | no | The postal address for the page footer, at most 500 characters. |
| `showMainSiteLink` | boolean | no | Whether the page shows a visible link to the main website: true or false. Null is refused. |

### Response 200

`data` is a `OutboundSite`.

| Field | Type | Description |
| --- | --- | --- |
| `mainSiteUrl` | string | The website you set for the page to link to and be rebuilt from. Omitted when the page uses the workspace website. |
| `effectiveMainSiteUrl` | string | The website the page links to and is rebuilt from: `mainSiteUrl`, else the workspace website. Omitted when neither is set. |
| `brandName` | string | The brand name the page shows. Omitted when not set. |
| `contactEmail` | string | The public contact email the page shows. Omitted when not set. |
| `legalName` | string | The company's legal name in the page footer. Omitted when not set. |
| `postalAddress` | string | The postal address in the page footer. Omitted when not set. |
| `showMainSiteLink` | boolean | True when the page shows a visible link to the main website. True until you change it. |
| `currentVersion` | OutboundSiteVersion | The version that every domain showing the page serves now. Omitted before the first build. |
| `latestRun` | OutboundSiteRun | The newest build, whatever its status. Omitted before the first build. |

### Request

```bash
curl -X PATCH "https://api.ken.so/v1/outbound-site" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "mainSiteUrl": "https://example.com",
  "brandName": "string",
  "contactEmail": "hello@acme.com",
  "legalName": "string",
  "postalAddress": "string",
  "showMainSiteLink": true
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "mainSiteUrl": "https://example.com",
    "effectiveMainSiteUrl": "https://example.com",
    "brandName": "string",
    "contactEmail": "jane@example.com",
    "legalName": "string",
    "postalAddress": "string",
    "showMainSiteLink": true,
    "currentVersion": {
      "id": 812,
      "source": "string",
      "note": "string",
      "htmlBytes": 1,
      "assetBytes": 1,
      "rounds": 1,
      "model": "string",
      "isBelowThreshold": true,
      "isCurrent": true,
      "runId": 812,
      "createdByUserId": 812,
      "createdAt": "2026-09-23T15:02:11Z"
    },
    "latestRun": {
      "id": 812,
      "status": "queued",
      "trigger": "string",
      "note": "string",
      "versionId": 812,
      "error": "string",
      "requestedByUserId": 812,
      "createdAt": "2026-09-23T15:02:11Z",
      "startedAt": "2026-09-23T15:02:11Z",
      "finishedAt": "2026-09-23T15:02:11Z"
    }
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### OutboundSiteVersion

One version of the outbound site page.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer (int64) | no | The version's id. |
| `source` | string | no | How the version was made: `generated` (a build), `regenerated_with_note` (a rebuild with a note) or `restored` (the copy a restore made). |
| `note` | string | no | The note the version was built with. On a restored copy, it names the version it came from. Omitted when there is none. |
| `htmlBytes` | integer (int64) | no | Size of the page's HTML, in bytes. |
| `assetBytes` | integer (int64) | no | Total size of the page's other files, such as images, in bytes. |
| `rounds` | integer (int32) | no | How many rounds the build took to reach this page. Omitted when not recorded. |
| `model` | string | no | The AI model that built the page. Omitted when not recorded. |
| `isBelowThreshold` | boolean | no | True when the build's visual check scored the page below its threshold. The page still went live, so it is worth a look. |
| `isCurrent` | boolean | no | True for the version that is live. |
| `runId` | integer (int64) | no | The build that made this version. Omitted when the version did not come from a build. |
| `createdByUserId` | integer (int64) | no | The member who started the build or restore. Omitted when Kenso made the version on its own. |
| `createdAt` | string (date-time) | no | When the version was made, in UTC. |

### OutboundSiteRun

One build of the outbound site page.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer (int64) | no | The build's id. |
| `status` | string | no | The build's state: `queued`, `running`, `succeeded`, `failed` or `canceled`. The live page changes only when a build succeeds. |
| `trigger` | string | no | What started the build: `first_page_domain` (the first domain set to show the page), `refresh` (a rebuild a member started), `refresh_with_note` (a rebuild with a note), `website_changed` (the linked website changed) or `content_changed` (Kenso found new content on the linked website). |
| `note` | string | no | The note sent with the rebuild. Omitted when there is none. |
| `versionId` | integer (int64) | no | The version the build made. Omitted until the build succeeds. |
| `error` | string | no | Why the build failed. Omitted when it did not fail. |
| `requestedByUserId` | integer (int64) | no | The member who started the build. Omitted for a build Kenso started on its own. |
| `createdAt` | string (date-time) | no | When the build was queued, in UTC. |
| `startedAt` | string (date-time) | no | When the build started, in UTC. Omitted while it is queued. |
| `finishedAt` | string (date-time) | no | When the build ended, in UTC. Omitted until it ends. |
