Change a workspace’s name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.
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
From
To
Allowed
DRAFT
LIVE
Yes, activates the workspace
DRAFT
ARCHIVED
Yes
LIVE
ARCHIVED
Yes, once generation is idle
ARCHIVED
LIVE
Yes, restores it
LIVE or ARCHIVED
DRAFT
No, returns 409
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.
Invalid field, for example a country code that is not ISO 3166-1 alpha-2
403
INSUFFICIENT_PLAN
Archiving requires an agency, or a team over its workspace limit
409
CONFLICT
Restoring would duplicate an active workspace for the same domain and market
409
INVALID_STATE_TRANSITION
The transition is not allowed
409
RESOURCE_BUSY
Answers are still being generated; retry later
409
QUOTA_EXCEEDED
Activating would exceed your workspace limit
412
PRECONDITION_FAILED
The workspace changed since your read
428
PRECONDITION_REQUIRED
If-Match was missing
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Qwairy Documentation","colors":{"primary":"#7b3aee","light":"#9f6aff","dark":"#6930c3"},"logo":{"light":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531","dark":"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/dark.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=785d06dbaa640b3277a1ccb1db2681f4"},"favicon":"https://mintcdn.com/qwairy/iJ9osnRZHsYMWu0z/favicon.svg?fit=max\u0026auto=format\u0026n=iJ9osnRZHsYMWu0z\u0026q=85\u0026s=ce439f6d1ab0e2580c3e94fffa248755","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true},"url":"full","mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://www.qwairy.co"}},"navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.qwairy.co/dashboard"}},"search":{"prompt":"Search documentation..."},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"documentation/get-started/what-is-qwairy"},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co/dashboard"}},"href":"fr/documentation/get-started/what-is-qwairy"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"qwairy","hasAudioNarration":false,"actualSubdomain":"qwairy","customDomains":["docs.qwairy.co"],"gitSource":{"type":"github","owner":"nicolasilhe","repo":"docs.qwairy.co","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aff3fdd8b67b28b9f2a7ce1","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"API","count":101},{"language":"fr","tag":"API","count":101},{"language":"en","tag":"Product","count":77},{"language":"fr","tag":"Produit","count":77},{"language":"en","tag":"Use cases","count":72},{"language":"fr","tag":"Cas d’usage","count":72},{"language":"en","tag":"MCP","count":39},{"language":"fr","tag":"MCP","count":39},{"language":"en","tag":"Configure data","count":27},{"language":"fr","tag":"Configurer les données","count":27},{"language":"en","tag":"Monitor and measure","count":25},{"language":"fr","tag":"Suivi et mesure","count":25},{"language":"en","tag":"Measure","count":23},{"language":"fr","tag":"Measure","count":23},{"language":"en","tag":"Get started","count":21},{"language":"fr","tag":"Bien démarrer","count":21},{"language":"en","tag":"Changelog","count":20},{"language":"en","tag":"Release notes","count":20},{"language":"fr","tag":"Nouveautés","count":20},{"language":"fr","tag":"Notes de version","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navigation-items,#navigation-items *{hyphens:manual}#content a[id]:not([href]){scroll-margin-top:var(--scroll-mt, 152px)}"}]}
{"page":{"pagePath":"developers/endpoints/brands/update","slug":"/developers/endpoints/brands/update","pageMetadata":{"title":"Update a workspace","description":"Change a workspace's name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.","api":"PATCH /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/update"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Change a workspace’s name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,ParamField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Updates properties and drives the workspace lifecycle. Send only the fields you\nwant to change.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Requires `,_jsx(_components.code,{children:`If-Match`}),`. See `,_jsx(_components.a,{href:`/developers/writing-data`,children:`Writing data`}),` for the\nread-then-write pattern.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`lifecycle`,children:`Lifecycle`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`From`}),_jsx(_components.th,{children:`To`}),_jsx(_components.th,{children:`Allowed`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`DRAFT`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`LIVE`})}),_jsx(_components.td,{children:`Yes, activates the workspace`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`DRAFT`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ARCHIVED`})}),_jsx(_components.td,{children:`Yes`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`LIVE`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ARCHIVED`})}),_jsx(_components.td,{children:`Yes, once generation is idle`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`ARCHIVED`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`LIVE`})}),_jsx(_components.td,{children:`Yes, restores it`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`LIVE`}),` or `,_jsx(_components.code,{children:`ARCHIVED`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`DRAFT`})}),_jsxs(_components.td,{children:[`No, returns `,_jsx(_components.code,{children:`409`})]})]})]})]}),`\n`,_jsx(_components.p,{children:`As in the dashboard, archiving is available to agencies, or to any team while\nit has more active workspaces than its plan includes. Restoring an archived\nworkspace is refused while another active workspace already tracks the same\ndomain for the same language and country.`}),`\n`,_jsxs(_components.p,{children:[`Activating a workspace never starts generation on its own. Start work\nexplicitly with `,_jsx(_components.a,{href:`/developers/endpoints/runs/manage`,children:`Estimate and start runs`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`After you change the name or move the workspace to `,_jsx(_components.code,{children:`LIVE`}),`, Qwairy evaluates\nagain the `,_jsx(_components.code,{children:`Branded`}),` or `,_jsx(_components.code,{children:`Non-branded`}),` system tag of the prompts that carry one.`]}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsxs(_components.p,{children:[`Bearer token. Example: `,_jsx(_components.code,{children:`Bearer qw-api-xxx`})]})}),`\n`,_jsx(ParamField,{header:`If-Match`,type:`string`,required:true,id:`param-if-match`,children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`ETag`}),` you last read for this workspace.`]})}),`\n`,_jsx(ParamField,{body:`name`,type:`string`,id:`param-name`,children:_jsx(_components.p,{children:`Display name`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsxs(_components.p,{children:[`Description, or `,_jsx(_components.code,{children:`null`}),` to clear it`]})}),`\n`,_jsx(ParamField,{body:`languageCode`,type:`string`,id:`param-language-code`,children:_jsx(_components.p,{children:`Two-letter language code`})}),`\n`,_jsx(ParamField,{body:`countryCode`,type:`string`,id:`param-country-code`,children:_jsxs(_components.p,{children:[`ISO 3166-1 alpha-2 country code, for example `,_jsx(_components.code,{children:`US`}),`. It becomes the default\ncountry, first in the workspace country catalog.`]})}),`\n`,_jsx(ParamField,{body:`status`,type:`string`,id:`param-status`,children:_jsxs(_components.p,{children:[`Target status: `,_jsx(_components.code,{children:`DRAFT`}),`, `,_jsx(_components.code,{children:`LIVE`}),` or `,_jsx(_components.code,{children:`ARCHIVED`})]})}),`\n`,_jsx(ParamField,{body:`url`,type:`string | null`,id:`param-url`,children:_jsxs(_components.p,{children:[`Workspace URL, at most 2048 characters, or `,_jsx(_components.code,{children:`null`}),` to clear it. The domain\nof the workspace cannot be changed.`]})}),`\n`,_jsx(ParamField,{body:`countryCodes`,type:`string[]`,id:`param-country-codes`,children:_jsx(_components.p,{children:`Complete replacement list of 1 to 50 uppercase two-letter country codes: the\nworkspace country catalog. The default country stays first. Removing a country\nalso removes it from the prompts that selected it; their past answers stay\navailable.`})}),`\n`,_jsx(ParamField,{body:`autoDetectCompetitors`,type:`boolean`,id:`param-auto-detect-competitors`,children:_jsx(_components.p,{children:`Whether Qwairy detects competitors automatically in answers. Disabling it\nstops new automatic additions; existing competitors are still tracked.`})}),`\n`,_jsx(ParamField,{body:`selfHostScope`,type:`string`,id:`param-self-host-scope`,children:_jsxs(_components.p,{children:[`Scope of the workspace pages and sources: `,_jsx(_components.code,{children:`REGISTRABLE`}),` for the registrable\ndomain and its relevant subdomains, or `,_jsx(_components.code,{children:`EXACT_HOST`}),` for the exact host and its\nsub-subdomains only. A read can return `,_jsx(_components.code,{children:`AUTO`}),`, but a write does not accept it.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Returns `,_jsx(_components.code,{children:`200`}),`, the new `,_jsx(_components.code,{children:`ETag`}),` and a `,_jsx(_components.code,{children:`workspace`}),` object with the fields of\n`,_jsx(_components.a,{href:`/developers/endpoints/brands/create#response`,children:`Create a workspace`}),`, including\n`,_jsx(_components.code,{children:`url`}),`, `,_jsx(_components.code,{children:`countryCodes`}),`, `,_jsx(_components.code,{children:`autoDetectCompetitors`}),` and `,_jsx(_components.code,{children:`selfHostScope`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`synthetic-request`,children:`Synthetic request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PATCH`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://www.qwairy.co/api/v1/brands/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$BRAND_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$QWAIRY_API_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'If-Match: \"0\"'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"status\": \"LIVE\"}'`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID_REQUEST`})}),_jsx(_components.td,{children:`Invalid field, for example a country code that is not ISO 3166-1 alpha-2`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INSUFFICIENT_PLAN`})}),_jsx(_components.td,{children:`Archiving requires an agency, or a team over its workspace limit`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`CONFLICT`})}),_jsx(_components.td,{children:`Restoring would duplicate an active workspace for the same domain and market`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INVALID_STATE_TRANSITION`})}),_jsx(_components.td,{children:`The transition is not allowed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`RESOURCE_BUSY`})}),_jsx(_components.td,{children:`Answers are still being generated; retry later`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`QUOTA_EXCEEDED`})}),_jsx(_components.td,{children:`Activating would exceed your workspace limit`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`412`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`PRECONDITION_FAILED`})}),_jsx(_components.td,{children:`The workspace changed since your read`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`428`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`PRECONDITION_REQUIRED`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`If-Match`}),` was missing`]})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a workspace","description":"Change a workspace's name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.","api":"PATCH /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/update"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Lifecycle","slug":"lifecycle","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Synthetic request","slug":"synthetic-request","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Update a workspace","path":"/api/v1/brands/{brandId}","servers":[{"url":"https://www.qwairy.co"}],"method":"patch","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{"Authorization":{"schema":[{"type":"string","description":"Bearer token. Example: `Bearer qw-api-xxx`","required":true}]},"If-Match":{"schema":[{"type":"string","description":"The `ETag` you last read for this workspace.","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"name":[{"type":"string","description":"Display name"}],"description":[{"type":"string","description":"Description, or `null` to clear it"}],"languageCode":[{"type":"string","description":"Two-letter language code"}],"countryCode":[{"type":"string","description":"ISO 3166-1 alpha-2 country code, for example `US` . It becomes the default country, first in the workspace country catalog."}],"status":[{"type":"string","description":"Target status: `DRAFT` , `LIVE` or `ARCHIVED`"}],"url":[{"type":"object","properties":{},"description":"Workspace URL, at most 2048 characters, or `null` to clear it. The domain of the workspace cannot be changed."}],"countryCodes":[{"type":"array","items":[{"type":"string"}],"description":"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."}],"autoDetectCompetitors":[{"type":"boolean","description":"Whether Qwairy detects competitors automatically in answers. Disabling it stops new automatic additions; existing competitors are still tracked."}],"selfHostScope":[{"type":"string","description":"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."}]}}],"examples":{"example":{"value":{"name":"\u003cstring>","description":"\u003cstring>","languageCode":"\u003cstring>","countryCode":"\u003cstring>","status":"\u003cstring>","url":{},"countryCodes":["\u003cstring>"],"autoDetectCompetitors":true,"selfHostScope":"\u003cstring>"}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"qwairy","siteName":"Qwairy Documentation","title":"Update a workspace - Qwairy Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/developers/endpoints/brands/update","matchLevel":0},"fr":{"href":"/fr/developers/endpoints/brands/update","matchLevel":1}}},"lastModified":"2026-11-19T18:28:58.730Z","originalFileLocation":"developers/endpoints/brands/update.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Change a workspace\u0026#x27;s name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a workspace - Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Change a workspace\u0026#x27;s name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.qwairy.co/developers/endpoints/brands/update\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Brands\u0026amp;title=Update+a+workspace\u0026amp;description=Change+a+workspace%27s+name%2C+URL%2C+countries%2C+competitor+detection+and+domain+scope%2C+and+move+it+through+its+lifecycle+using+the+current+ETag+in+If-Match.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=d8304b6dd3c5ef180198c3934978f19a1cbbd9d5d5dedd0219bf4643d4a61c48\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a workspace - Qwairy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Change a workspace\u0026#x27;s name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://qwairy.mintlify.site/_mintlify/api/og/v2?division=Brands\u0026amp;title=Update+a+workspace\u0026amp;description=Change+a+workspace%27s+name%2C+URL%2C+countries%2C+competitor+detection+and+domain+scope%2C+and+move+it+through+its+lifecycle+using+the+current+ETag+in+If-Match.\u0026amp;theme=5fc1096560764d127b1f112c\u0026amp;signature=d8304b6dd3c5ef180198c3934978f19a1cbbd9d5d5dedd0219bf4643d4a61c48\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/qwairy/HD3tsXct7NQqOMQS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Qwairy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7b3aee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.qwairy.co/developers/endpoints/brands/update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/endpoints/brands/update.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.qwairy.co/developers/endpoints/brands/update\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.qwairy.co/fr/developers/endpoints/brands/update\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.qwairy.co/developers/endpoints/brands/update\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.qwairy.co/#organization\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/qwairy/4Z9ttgZtiIq38oup/logo/light.png?fit=max\u0026auto=format\u0026n=4Z9ttgZtiIq38oup\u0026q=85\u0026s=cb8e1f59f1718fe629b0c49f6b48f531\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.qwairy.co#website\",\"name\":\"Qwairy Documentation\",\"url\":\"https://docs.qwairy.co\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/brands/update#webpage\",\"url\":\"https://docs.qwairy.co/developers/endpoints/brands/update\",\"name\":\"Update a workspace\",\"description\":\"Change a workspace's name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.\",\"dateModified\":\"2026-11-19T18:28:58.730Z\",\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/brands/update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.qwairy.co/developers/endpoints/brands/update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Configure data\",\"item\":\"https://docs.qwairy.co/developers/endpoints/brands/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Brands\",\"item\":\"https://docs.qwairy.co/developers/endpoints/brands/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a workspace\",\"item\":\"https://docs.qwairy.co/developers/endpoints/brands/update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.qwairy.co/developers/endpoints/brands/update#apireference\",\"headline\":\"Update a workspace\",\"name\":\"Update a workspace\",\"description\":\"Change a workspace's name, URL, countries, competitor detection and domain scope, and move it through its lifecycle using the current ETag in If-Match.\",\"url\":\"https://docs.qwairy.co/developers/endpoints/brands/update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.qwairy.co/developers/endpoints/brands/update#webpage\"},\"dateModified\":\"2026-11-19T18:28:58.730Z\",\"publisher\":{\"@id\":\"https://docs.qwairy.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.qwairy.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Qwairy Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Qwairy Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/endpoints/brands/update.md","siteName":"Qwairy Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Product","pages":[{"title":"Product","href":"/documentation/get-started/what-is-qwairy"}]},{"tab":"API","groups":[{"group":"Get started","pages":[{"title":"Introduction","icon":"book-open","href":"/developers/introduction"},{"title":"Endpoint catalog","href":"/developers/endpoints/index"},{"title":"Quick start","href":"/developers/guides/index"},{"title":"Authentication","icon":"key","href":"/developers/authentication"},{"title":"API tokens","href":"/developers/api-keys"},{"title":"Writing data","icon":"pen-to-square","href":"/developers/writing-data"},{"title":"Rate limits","icon":"gauge","href":"/developers/rate-limits"},{"title":"Error codes","icon":"triangle-exclamation","href":"/developers/errors"},{"title":"Entities","icon":"cubes","href":"/developers/entities"}]},{"group":"Configure data","pages":[{"group":"Brands","pages":[{"title":"List brands","api":"GET /api/v1/brands","href":"/developers/endpoints/brands/list"},{"title":"Get brand","api":"GET /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/get"},{"title":"Create a workspace","description":"Create a workspace in DRAFT status. Nothing else happens: no domain analysis, no description generation and no billable run until you activate it.","api":"POST /api/v1/brands","href":"/developers/endpoints/brands/create"},{"title":"Update a workspace","api":"PATCH /api/v1/brands/{brandId}","href":"/developers/endpoints/brands/update"},{"title":"Get monitoring","description":"Read the effective monitoring schedule of a workspace, its selected models and the ETag you need to update them. Defaults are returned when nothing is saved.","api":"GET /api/v1/brands/{brandId}/monitoring","href":"/developers/endpoints/brands/monitoring"},{"title":"Update monitoring","api":"PATCH /api/v1/brands/{brandId}/monitoring","href":"/developers/endpoints/brands/update-monitoring"}]},{"group":"Topics","pages":[{"title":"List topics","api":"GET /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/list"},{"title":"Get a topic","api":"GET /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/get"},{"title":"Create a topic","api":"POST /api/v1/brands/{brandId}/keywords","href":"/developers/endpoints/keywords/manage"},{"title":"Update a topic","api":"PATCH /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/update"},{"title":"Delete a topic","api":"DELETE /api/v1/brands/{brandId}/keywords/{keywordId}","href":"/developers/endpoints/keywords/delete"},{"title":"Topic evolution","api":"GET /api/v1/brands/{brandId}/keywords/{keywordId}/evolution","href":"/developers/endpoints/keywords/evolution"}]},{"group":"Tags","pages":[{"title":"List tags","api":"GET /api/v1/brands/{brandId}/tags","href":"/developers/endpoints/tags/list"},{"title":"Get a tag","api":"GET /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/get"},{"title":"Create a tag","api":"POST /api/v1/brands/{brandId}/tags","href":"/developers/endpoints/tags/create"},{"title":"Update a tag","api":"PATCH /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/update"},{"title":"Delete a tag","api":"DELETE /api/v1/brands/{brandId}/tags/{tagId}","href":"/developers/endpoints/tags/delete"},{"title":"Tag evolution","api":"GET /api/v1/brands/{brandId}/tags/{tagId}/evolution","href":"/developers/endpoints/tags/evolution"}]},{"group":"Prompt suggestions","pages":[{"title":"Get prompt suggestions","api":"GET /api/v1/brands/{brandId}/prompt-suggestions","href":"/developers/endpoints/prompt-suggestions/get"},{"title":"Generate prompt suggestions","api":"POST /api/v1/brands/{brandId}/prompt-suggestions/runs","href":"/developers/endpoints/prompt-suggestions/generate"},{"title":"Get a suggestion generation","api":"GET /api/v1/brands/{brandId}/prompt-suggestions/runs/{suggestionRunId}","href":"/developers/endpoints/prompt-suggestions/get-run"},{"title":"Accept prompt suggestions","api":"POST /api/v1/brands/{brandId}/prompt-suggestions/accept","href":"/developers/endpoints/prompt-suggestions/accept"}]},{"title":"Estimate a run","api":"POST /api/v1/brands/{brandId}/runs/estimate","href":"/developers/endpoints/runs/estimate"},{"title":"Start a run","api":"POST /api/v1/brands/{brandId}/runs","href":"/developers/endpoints/runs/manage"},{"title":"List runs","api":"GET /api/v1/brands/{brandId}/runs","href":"/developers/endpoints/runs/list"},{"title":"Get a run","api":"GET /api/v1/brands/{brandId}/runs/{runId}","href":"/developers/endpoints/runs/get"},{"title":"Credits","api":"GET /api/v1/credits","href":"/developers/endpoints/credits"}]},{"group":"Monitor and measure","pages":[{"group":"Performance","pages":[{"title":"Get performance snapshot","api":"GET /api/v1/brands/{brandId}/performance","href":"/developers/endpoints/performance"},{"title":"Get GEO matrix","api":"GET /api/v1/brands/{brandId}/matrix","href":"/developers/endpoints/matrix"}]},{"group":"Prompts","pages":[{"title":"List prompts","api":"GET /api/v1/brands/{brandId}/prompts","href":"/developers/endpoints/prompts/list"},{"title":"Get prompt","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}","href":"/developers/endpoints/prompts/get"},{"title":"Prompt answers","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/answers","href":"/developers/endpoints/prompts/answers"},{"title":"Prompt evolution","api":"GET /api/v1/brands/{brandId}/prompts/{promptId}/evolution","href":"/developers/endpoints/prompts/evolution"},{"title":"Create a prompt","api":"POST /api/v1/brands/{brandId}/prompts","href":"/developers/endpoints/prompts/manage"},{"title":"Update a prompt","api":"PATCH /api/v1/brands/{brandId}/prompts/{promptId}","href":"/developers/endpoints/prompts/update"},{"title":"Bulk update prompts","api":"POST /api/v1/brands/{brandId}/prompts/bulk","href":"/developers/endpoints/prompts/bulk"}]},{"group":"Answers","pages":[{"title":"List answers","api":"GET /api/v1/brands/{brandId}/answers","href":"/developers/endpoints/answers/list"},{"title":"Get answer","api":"GET /api/v1/brands/{brandId}/answers/{answerId}","href":"/developers/endpoints/answers/get"}]},{"group":"Competitors","pages":[{"title":"List competitors","api":"GET /api/v1/brands/{brandId}/competitors","href":"/developers/endpoints/competitors/list"},{"title":"Get competitor","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}","href":"/developers/endpoints/competitors/get"},{"title":"Competitor evolution","api":"GET /api/v1/brands/{brandId}/competitors/{competitorId}/evolution","href":"/developers/endpoints/competitors/evolution"}]},{"group":"Sources","pages":[{"title":"List source domains","api":"GET /api/v1/brands/{brandId}/source-domains","href":"/developers/endpoints/source-domains/list"},{"title":"Get source domain","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}","href":"/developers/endpoints/source-domains/get"},{"title":"Source domain evolution","api":"GET /api/v1/brands/{brandId}/source-domains/{sourceId}/evolution","href":"/developers/endpoints/source-domains/evolution"},{"title":"List source URLs","api":"GET /api/v1/brands/{brandId}/source-urls","href":"/developers/endpoints/source-urls"}]},{"group":"Signals","pages":[{"title":"List query fan-out records","api":"GET /api/v1/brands/{brandId}/search","href":"/developers/endpoints/search"},{"title":"List follow-ups","api":"GET /api/v1/brands/{brandId}/follow-ups","href":"/developers/endpoints/follow-ups"},{"title":"List shopping results","api":"GET /api/v1/brands/{brandId}/shopping","href":"/developers/endpoints/shopping"},{"title":"List local business insights","api":"GET /api/v1/brands/{brandId}/local","href":"/developers/endpoints/local"},{"title":"List social signals","api":"GET /api/v1/brands/{brandId}/social","href":"/developers/endpoints/social"},{"title":"List sponsored content","api":"GET /api/v1/brands/{brandId}/sponsored","href":"/developers/endpoints/sponsored"}]},{"title":"Get crawler analytics","api":"GET /api/v1/brands/{brandId}/crawler-analytics","href":"/developers/endpoints/crawler-analytics"}]},{"group":"Analyze and act","pages":[{"group":"Perception","pages":[{"title":"List perception snapshots","api":"GET /api/v1/brands/{brandId}/perception","href":"/developers/endpoints/perception/list"},{"title":"Get perception snapshot","api":"GET /api/v1/brands/{brandId}/perception/{snapshotId}","href":"/developers/endpoints/perception/get"}]},{"group":"Actions","pages":[{"title":"List actions","api":"GET /api/v1/brands/{brandId}/actions","href":"/developers/endpoints/actions/list"},{"title":"Update an action status","api":"PATCH /api/v1/brands/{brandId}/actions/{actionId}","href":"/developers/endpoints/actions/update-status"}]},{"group":"Content","pages":[{"title":"List content","api":"GET /api/v1/brands/{brandId}/content","href":"/developers/endpoints/content/list"},{"title":"Get content","api":"GET /api/v1/brands/{brandId}/content/{articleId}","href":"/developers/endpoints/content/get"}]},{"title":"Get Site Readiness analysis","api":"GET /api/v1/brands/{brandId}/technical-analysis","href":"/developers/endpoints/technical-analysis"},{"group":"Site diagnostics","pages":[{"title":"List monitored pages","api":"GET /api/v1/brands/{brandId}/site-diagnostics","href":"/developers/endpoints/site-diagnostics/list"},{"title":"Get a monitored page","api":"GET /api/v1/brands/{brandId}/site-diagnostics/{pageId}","href":"/developers/endpoints/site-diagnostics/get"},{"title":"Add pages to monitor","api":"POST /api/v1/brands/{brandId}/site-diagnostics/pages","href":"/developers/endpoints/site-diagnostics/add-pages"},{"title":"Start a page audit","api":"POST /api/v1/brands/{brandId}/site-diagnostics/audits","href":"/developers/endpoints/site-diagnostics/start-audit"},{"title":"Get a page audit","api":"GET /api/v1/brands/{brandId}/site-diagnostics/audits/{siteAuditId}","href":"/developers/endpoints/site-diagnostics/get-audit"}]}]},{"group":"Agency and automation","pages":[{"group":"Pitch audits","pages":[{"title":"Create a Pitch Audit","api":"POST /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/create"},{"title":"Save Pitch Audit prompts","api":"PATCH /api/v1/pitch-audits/{auditId}/prompts","href":"/developers/endpoints/pitch-audits/save-prompts"},{"title":"Confirm a Pitch Audit","api":"POST /api/v1/pitch-audits/{auditId}/confirm","href":"/developers/endpoints/pitch-audits/confirm"},{"title":"List Pitch Audits","api":"GET /api/v1/pitch-audits","href":"/developers/endpoints/pitch-audits/list"},{"title":"Get Pitch Audit","api":"GET /api/v1/pitch-audits/{auditId}","href":"/developers/endpoints/pitch-audits/get"},{"title":"Get Pitch Audit subject report","api":"GET /api/v1/pitch-audits/{auditId}/reports/{subjectId}","href":"/developers/endpoints/pitch-audits/get-report"}]},{"title":"Outbound webhooks","href":"/developers/webhooks"}]},{"group":"Integration webhooks","pages":[{"title":"Integration webhooks","href":"/developers/integration-webhooks/overview"},{"title":"Integration webhook events","href":"/developers/integration-webhooks/events"},{"title":"Verify webhook signatures","href":"/developers/integration-webhooks/verify-signatures"},{"group":"Webhook endpoints","pages":[{"title":"List webhook endpoints","api":"GET /api/v1/webhooks","href":"/developers/endpoints/webhooks/list"},{"title":"Create a webhook endpoint","api":"POST /api/v1/webhooks","href":"/developers/endpoints/webhooks/create"},{"title":"Get a webhook endpoint","api":"GET /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/get"},{"title":"Update a webhook endpoint","api":"PATCH /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/update"},{"title":"Delete a webhook endpoint","api":"DELETE /api/v1/webhooks/{webhookId}","href":"/developers/endpoints/webhooks/delete"},{"title":"Rotate the signing secret","api":"POST /api/v1/webhooks/{webhookId}/rotate-secret","href":"/developers/endpoints/webhooks/rotate-secret"},{"title":"Send a test event","api":"POST /api/v1/webhooks/{webhookId}/test","href":"/developers/endpoints/webhooks/test"},{"title":"List deliveries","api":"GET /api/v1/webhooks/{webhookId}/deliveries","href":"/developers/endpoints/webhooks/deliveries"},{"title":"Redeliver an event","api":"POST /api/v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver","href":"/developers/endpoints/webhooks/redeliver"}]}]},{"group":"Implementation guides","pages":[{"title":"Custom dashboard","href":"/developers/guides/custom-dashboard"},{"title":"Weekly reports","href":"/developers/guides/weekly-reports"},{"title":"Competitive analysis","href":"/developers/guides/competitive-analysis"},{"title":"Data export","href":"/developers/guides/data-export"},{"title":"Onboard a client with the API","href":"/developers/guides/onboard-client-api"},{"title":"Sync prompts from a spreadsheet with n8n","href":"/developers/guides/sync-prompts-n8n"},{"title":"Update an action, then audit pages","href":"/developers/guides/page-audit-site-diagnostics"},{"title":"Run a Pitch Audit for a prospect with MCP","href":"/developers/guides/pitch-audit-prospect-mcp"},{"title":"Add prompt suggestions with MCP","href":"/developers/guides/prompt-suggestions-mcp"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/introduction"}]},{"tab":"Looker Studio","pages":[{"title":"Looker Studio","href":"/looker-studio/getting-started"}]},{"tab":"Agencies","pages":[{"title":"Agencies","href":"/agencies/introduction"}]},{"tab":"Use cases","pages":[{"title":"Use cases","href":"/use-cases"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/updates/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.qwairy.co/blog"},{"anchor":"GEO Guide","icon":"book-open","href":"https://www.qwairy.co/guides/complete-guide-to-generative-engine-optimization"}]}},{"language":"fr","navbar":{"links":[{"href":"mailto:team@qwairy.co","label":"Support"}],"primary":{"type":"button","label":"Tableau de bord","href":"https://www.qwairy.co/dashboard"}},"pages":[{"title":"fr","href":"/fr/developers/endpoints/brands/update"}]}]},"basePath":"","title":"Update a workspace - Qwairy Documentation","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js"]}