---
title: "Create website key page"
method: POST
path: "/api/website-key-pages"
tags: ["website_key_pages"]
---

# Create website key page

`POST /api/website-key-pages`

## Request

- Base URL: `https://beta.getsales.io/signals/v1`
- URL: `https://beta.getsales.io/signals/v1/api/website-key-pages`
- Auth: HTTP bearer and API key in header `Team-SID`

Name a page whose visits matter: site_sid, a stable slug (key, lowercase, immutable), a label, a path glob (pattern: a path or a pasted URL, * for any run of characters, matching ignores case and a trailing slash) and is_conversion. A match in a session is highlighted in the feed and becomes the fact website_key_page_visited. One page per key per site: a duplicate is 409 duplicate_rejected with the existing sid.

Contract:
- MCP tool `create_website_key_page`, registry package `mcp.signals/website_key_pages`, mount `signals.website`.
- Operation `create`, response envelope `create`.
- Flags: none.

## Request body

- CreateWebsiteKeyPageRequest: Request body of `create_website_key_page`.
  - `site_sid` string, required: Website site sid (sg_si_...), the page's site.
  - `key` string, required: A stable lowercase slug, unique within the site, immutable: the name facts, the key_page filter and the signal visited_key_page carry.
  - `label` string, required: What the page is called in the feed (Pricing).
  - `pattern` string, required: A path glob or a pasted URL (reduced to its path): * stands for any run of characters, matching ignores case and a trailing slash (/plans*). No path readable is 422 invalid_pattern.
  - `is_conversion` boolean: Count a visit as a conversion. Default false: visiting /signup is not a signup.

## Response `200`

`create` success envelope.

- CreateWebsiteKeyPageResponse
  - `success` true, required
  - `operation` 'create', required
  - `item` object, required
    - `sid` string, required: Website key page sid (sg_kp_...).
    - `team_sid` string, required: Owning team (ts_tm_..., external: gs.service.id).
    - `site_sid` string, required: The site the page belongs to (sg_si_...).
    - `key` string, required: The stable lowercase slug (pricing) facts and signals carry; immutable.
    - `label` string, required: What the page is called in the feed.
    - `pattern` string, required: The path glob as stored: a leading slash, lowercased, no query or fragment, * for any run of characters (/pricing*).
    - `is_conversion` boolean, required: Counted as a conversion in the feed and the Overview card.
    - `created_by` object, required: Actor that named the page (the site create, or this entity's create).
      - `actor_type` 'user' | 'support' | 'api_key' | 'system' | 'agent', required
      - `actor_sid` string, nullable, required
      - `team_sid` string, required
      - `actor_name` string, nullable: The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job.
      - `oauth_client_sid` string, nullable: The acting OAuth client (id_oc_*); null off the OAuth path.
      - `reason` string, nullable: Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise.
      - `permissions` object, required: Internal audit context: the grant set the actor held at write time. Not a contract.
      - `cluster_id` integer, nullable: Internal audit context: the cluster that served the write.
      - `trace_id` string, nullable: Internal audit context: the trace id of the request that wrote the row.
    - `created_at` string, required: ISO 8601 UTC.
    - `updated_at` string, required: ISO 8601 UTC.
    - `deleted_at` string, nullable, required: ISO 8601 UTC; null = live. Also set by the site's cleanup job.
  - `already_exists` boolean, required
  - `meta` object, required
    - `trace_id` string, required: UUID v7; same 128-bit value as the X-Trace-Id header.
    - `span_id` string, required: 16 hex chars, root span of this request.
    - `timestamp` string, required: ISO 8601 UTC (Y-m-dTH:i:sZ), response time.
    - `duration_ms` integer, required: Server-side wall clock.
    - `team_sid` string, nullable: The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends.
    - `actor_type` string, nullable: user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends.

## Other responses

- `4XX`: MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented.
- `5XX`: MCP error envelope with `error.code` internal_error or service_unavailable.

---

[API](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-signals.md) - [All operations](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-signals/llms.txt) - [OpenAPI document](https://skmtc.dev/getsales/apis/getsales-public-contract-gs-service-signals/revisions/310ca5d2219d?raw)