iAdvizeDocs

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.

PATCH
/api/v1/sites/{siteId}

Authorization

ApiKeyAuth
AuthorizationBearer <token>

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

siteId*string

The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/api/v1/sites/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Demo Storefront (EU)",    "platform": "shopify",    "url": "https://demo-storefront.example.com"  }'
{  "data": {    "id": "string",    "name": "string",    "platform": "shopify",    "url": "string",    "siteInformation": "string",    "toneOfVoice": "string",    "vertical": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Get a site

Returns a single site by id. A cross-tenant id is a 404.

Delete a site

Deletes the site. Its agents and connectors are detached (their `siteId`/`site_id` cleared), never deleted: they become org-level/unassigned. Returns the id and a deleted flag. An organization keeps at least one site: deleting its only one is refused with `409`.