Umami · Schema

WebsiteRequest

Request body for creating or updating a website

Cookieless TrackingOpen SourcePrivacyWeb AnalyticsWebsite Analytics

Properties

Name Type Description
name string Display name for the website
domain string Website domain
shareId string Custom share identifier
teamId string Team identifier for team ownership
View JSON Schema on GitHub

JSON Schema

umami-website-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12",
  "$id": "https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-website-request-schema.json",
  "title": "WebsiteRequest",
  "description": "Request body for creating or updating a website",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the website",
      "examples": [
        "My Website"
      ]
    },
    "domain": {
      "type": "string",
      "description": "Website domain",
      "examples": [
        "example.com"
      ]
    },
    "shareId": {
      "type": "string",
      "description": "Custom share identifier",
      "examples": [
        null
      ]
    },
    "teamId": {
      "type": "string",
      "description": "Team identifier for team ownership",
      "format": "uuid",
      "examples": [
        null
      ]
    }
  },
  "required": [
    "name",
    "domain"
  ]
}