Update a Website — POST /api/websites/{websiteId}

Use this endpoint to change a website’s name, domain, sharing settings, or session recording configuration. You only need to include the fields you want to change — any field you omit remains unchanged. The response returns the full updated website object so you can confirm every value. POST /api/websites/{websiteId}

Request

Headers

string

required

Bearer token. Pass your API key: Authorization: Bearer <api-key>

string

required

Must be application/json.

Path Parameters

string

required

The unique UUID of the website to update.

Body Parameters

string

New display name for the website.

string

New domain to associate with this website, e.g. "newdomain.com".

New public share token. Set to null to disable public sharing, or provide a unique string to enable or change the share link.

object

Session replay and heatmap recording settings to update. All sub-fields are optional.

boolean

Enable or disable session replay recording.

boolean

Enable or disable heatmap data capture.

number

Fraction of sessions to record, from 0.0 (none) to 1.0 (all).

number

Fraction of sessions from which heatmap data is captured.

string

Privacy masking level: "strict", "moderate", or "none".

string

CSS selector targeting DOM elements to exclude from recordings.

number

Maximum session recording length in seconds. Use 0 for no limit.

Response

200 – Success Returns the full updated website object.

string

required

UUID of the website.

string

required

Updated display name.

string | null

required

Updated domain.

Updated public share token, or null.

string | null

required

UUID of the assigned team, unchanged by this operation.

string | null

required

UUID of the owning user.

string | null

required

UUID of the user who created the website.

boolean

required

Whether recording is currently active.

object

required

The updated session replay and heatmap recording configuration.

string | null

required

Timestamp of the last analytics data reset.

string | null

required

ISO 8601 timestamp when the website was originally created.

string | null

required

ISO 8601 timestamp of this update.

string | null

required

ISO 8601 timestamp when the website was deleted, or null if it is active.

object

Embedded owner information.

string

UUID of the owning user.

string

Username of the owning user.

200 Response

{
  "id": "b8d3a1f0-1c2d-4e5f-8a9b-0c1d2e3f4a5b",
  "name": "My Rebranded Site",
  "domain": "newdomain.com",
  "shareId": "public-dashboard-2024",
  "teamId": null,
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "recorderEnabled": true,
  "replayConfig": {
    "replayEnabled": true,
    "heatmapEnabled": true,
    "sampleRate": 0.05,
    "heatmapSampleRate": 0.1,
    "maskLevel": "strict",
    "blockSelector": ".payment-form",
    "maxDuration": 1800
  },
  "resetAt": null,
  "createdAt": "2024-03-01T10:00:00Z",
  "updatedAt": "2024-09-01T08:45:00Z",
  "deletedAt": null,
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "alice"
  }
}

Code Sample

curl -X POST 'https://api.umami.is/v1/websites/b8d3a1f0-1c2d-4e5f-8a9b-0c1d2e3f4a5b' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My Rebranded Site",
    "domain": "newdomain.com",
    "shareId": "public-dashboard-2024"
  }'

Overview

Websites

Stats & Events

Node Client

Update a Website — POST /api/websites/{websiteId}

Request

Headers

Path Parameters

Body Parameters

Response

Code Sample

​Request

​Headers

​Path Parameters

​Body Parameters

​Response

​Code Sample

Request

Headers

Path Parameters

Body Parameters

Response

Code Sample