Delete a site
Deletes the site. It disappears at once from the API (`404` under `/api/v1/sites/{siteId}`, absent from `GET /api/v1/sites`), the dashboard and the MCP server, and its tag and AI Storefront stop answering. Its agents and connectors stay attached to it and are not moved to another site. Nothing is erased: its agents, connectors, widgets, pages, starter questions and conversations stay stored. There is no restore endpoint. Returns the id and a deleted flag. Deleting the same site again returns `404`. An organization keeps at least one site: deleting its only one is refused with `409`.
Authorization
ApiKeyAuth A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).
In: header
Path Parameters
The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://example.com/api/v1/sites/string"{ "data": { "id": "site_01kvnwmagvf27rc9cze5rm9e1r", "deleted": true }}Update a site
Replaces the site's `name`, `platform`, and `url` together, and optionally patches its AI-assistant-context fields (`siteInformation`, `toneOfVoice`, `vertical`). This does not accept a partial `name`/`platform`/`url` update: always send all three, unless the body carries only settings (the automation settings `autoGenerateStarters`, `switchOnGeneratedStarters`, `pageViewCountingEnabled`, `storefrontCartCountingEnabled`, `autoReadPages`, `autoReadMinViews`, `tagMonitoringEnabled`, the panel colours `panelColors`, the panel side and opening mode `panelPosition` and `panelBackdrop`, and the Panel reduced state button's `resumeButton`), which change those settings and nothing else. Each changed setting records its own audit entry (`autoReadPages` and `autoReadMinViews` share one, so do `panelPosition` and `panelBackdrop`, and `resumeButton` records one only when a value changed), and a body that mixes settings with other fields also records the site update. The whole body is validated before anything is written, so an invalid threshold, colour or offset changes nothing.
Get a site's storefront activity
Returns when the site last received an add-to-cart and an order from its storefront, and an order from an order webhook, as server receive times. Each time is `null` until the first one arrives. A time that stops moving points to a channel that stopped sending. Answers for any site, whatever its platform or connectors. Read-only; the counts are in the add-to-cart counts and the Sales report.