Change project settings

PATCH

/v2/projects/{project}

Name, visibility, publicVisitorData, sqlEnabled, widgetReports, allowed origins and retention.

Authorization

AuthorizationBearer <token>

An API token from POST /v2/tokens (at_live_...), or a project's secret key (sk_...) for server-side ingest.

In: header

Path Parameters

project*string

The project id, as listed by GET /v2/projects.

Length1 <= length

Request Body

Only the fields sent are changed; send at least one.

TypeScript Definitions

Use the request body type in TypeScript.

Only the fields sent are changed; send at least one.

Properties1 <= properties

name?string

Display name.

Length1 <= length <= 128

visibility?string

public projects can be read without signing in; private ones need access.

Value in

"public"
"private"

publicVisitorData?boolean

On a public project, also lets anyone read visitor-level data: events, visitors and sessions. Off by default.

sqlEnabled?boolean

Allows the SQL console on this project for admins, analysts and sql tokens. Owners can always run SQL. On by default.

widgetReports?boolean

Accepts SDK outcome reports at POST /v2/projects/{project}/logs/client. Off by default.

allowedOrigins?array<>

Origins that may send events with the public key, matched exactly, such as https://remcostoeten.nl. An empty list allows every origin.

retentionDays?integer

Days events and sessions are kept before the cleanup job deletes them; 90 by default.

Range1 <= value <= 3650

Response Body

`application/json`

curl -X PATCH "https://example.com/v2/projects/string" \  -H "Content-Type: application/json" \  -d '{    "visibility": "public",    "retentionDays": 180  }'

{  "data": {    "id": "client-portal",    "visibility": "public",    "publicVisitorData": false,    "retentionDays": 180,    "updatedAt": "2026-09-27T16:42:00.000Z"  }}

Change project settings

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

503application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`