Update project
Edit identity, website scope or archive status. Restoring does not enable tracking.
/projects/{projectId}projects:writeA current account Admin with access to this project is required.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Path parameters
projectIdstringRequiredProject identifier from List projects.
Request body
application/json. Unknown fields are rejected. Changes apply only to supplied fields; provide at least one field.
namestringOptionalProject name: 1–100 characters.
domainstringOptionalPublic website domain, up to 500 characters; no credentials or port.
websiteUrlstring | nullOptionalOptional HTTP(S) URL on the project domain, up to 2,000 characters.
marketstringOptionalSupported country code.
languagestringOptionalSupported language code.
targetStatestring | nullOptionalSupported two-letter US state, or null for all states.
brandAliasesstring[]OptionalUp to 30 additional names, each 1–200 characters.
domainAliasesstring[]OptionalUp to 30 public website domains.
includeSubdomainsbooleanOptionalInclude subdomains in website matching.
archivedbooleanOptionalArchive or restore. Archiving remains subject to the account subscription lifecycle policy.
Response fields
dataobjectRequiredEdit identity, website scope or archive status. Restoring does not enable tracking.
Child fields
idstringRequiredProject identifier.
workspaceIdstringRequiredOwning workspace.
namestringRequiredProject name.
domainstringRequiredPrimary website domain.
websiteUrlstring | nullRequiredWebsite scope URL.
marketstringRequiredCountry code.
targetStatestring | nullRequiredUS state code, if selected.
languagestringRequiredLanguage code.
brandAliasesstring[]RequiredAdditional brand names.
domainAliasesstring[]RequiredAdditional website domains.
includeSubdomainsbooleanRequiredWhether subdomains are included.
archivedbooleanRequiredWhether the project is archived.
createdAtISO 8601 timestampRequiredWhen the project was created.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.