Skip to main content
PATCH
Update a workspace
Updates properties and drives the workspace lifecycle. Send only the fields you want to change.
Requires If-Match. See Writing data for the read-then-write pattern.

Lifecycle

As in the dashboard, archiving is available to agencies, or to any team while it has more active workspaces than its plan includes. Restoring an archived workspace is refused while another active workspace already tracks the same domain for the same language and country. Activating a workspace never starts generation on its own. Start work explicitly with Estimate and start runs. After you change the name or move the workspace to LIVE, Qwairy evaluates again the Branded or Non-branded system tag of the prompts that carry one.
string
required
Bearer token. Example: Bearer qw-api-xxx
string
required
The ETag you last read for this workspace.
string
Display name
string
Description, or null to clear it
string
Two-letter language code
string
ISO 3166-1 alpha-2 country code, for example US. It becomes the default country, first in the workspace country catalog.
string
Target status: DRAFT, LIVE or ARCHIVED
string | null
Workspace URL, at most 2048 characters, or null to clear it. The domain of the workspace cannot be changed.
string[]
Complete replacement list of 1 to 50 uppercase two-letter country codes: the workspace country catalog. The default country stays first. Removing a country also removes it from the prompts that selected it; their past answers stay available.
boolean
Whether Qwairy detects competitors automatically in answers. Disabling it stops new automatic additions; existing competitors are still tracked.
string
Scope of the workspace pages and sources: REGISTRABLE for the registrable domain and its relevant subdomains, or EXACT_HOST for the exact host and its sub-subdomains only. A read can return AUTO, but a write does not accept it.

Response

Returns 200, the new ETag and a workspace object with the fields of Create a workspace, including url, countryCodes, autoDetectCompetitors and selfHostScope.

Synthetic request

Errors