Skip to content
ansvra.Documentation
Projects
Projects

Update project

Edit identity, website scope or archive status. Restoring does not enable tracking.

PATCH/projects/{projectId}
Required permission projects:write

A current account Admin with access to this project is required.

Authentication and permissions · Errors and limits

Authorization

Authorizationstring · headerRequired

Bearer access key. Never put a key in the URL.

Path parameters

projectIdstringRequired

Project identifier from List projects.

Request body

application/json. Unknown fields are rejected. Changes apply only to supplied fields; provide at least one field.

namestringOptional

Project name: 1–100 characters.

domainstringOptional

Public website domain, up to 500 characters; no credentials or port.

websiteUrlstring | nullOptional

Optional HTTP(S) URL on the project domain, up to 2,000 characters.

marketstringOptional

Supported country code.

languagestringOptional

Supported language code.

targetStatestring | nullOptional

Supported two-letter US state, or null for all states.

brandAliasesstring[]Optional

Up to 30 additional names, each 1–200 characters.

domainAliasesstring[]Optional

Up to 30 public website domains.

includeSubdomainsbooleanOptional

Include subdomains in website matching.

archivedbooleanOptional

Archive or restore. Archiving remains subject to the account subscription lifecycle policy.

Response fields

dataobjectRequired

Edit identity, website scope or archive status. Restoring does not enable tracking.

Child fields
idstringRequired

Project identifier.

workspaceIdstringRequired

Owning workspace.

namestringRequired

Project name.

domainstringRequired

Primary website domain.

websiteUrlstring | nullRequired

Website scope URL.

marketstringRequired

Country code.

targetStatestring | nullRequired

US state code, if selected.

languagestringRequired

Language code.

brandAliasesstring[]Required

Additional brand names.

domainAliasesstring[]Required

Additional website domains.

includeSubdomainsbooleanRequired

Whether subdomains are included.

archivedbooleanRequired

Whether the project is archived.

createdAtISO 8601 timestampRequired

When the project was created.

metaobjectRequired

Request metadata. Present on JSON success responses.

Child fields
requestIdstringRequired

Request identifier to include when contacting support.

resultScope"saved"Required

Saved customer information; excludes Overview preview results.

Ansvra

A clearer next step.

MEET YOUR AI GUIDE

A little clarity.
A clearer next move.

Ask about Ansvra, AI visibility, or your next step with content.

Opening chat…