Umami · Schema

TeamRequest

Request body for creating or updating a team

Cookieless TrackingOpen SourcePrivacyWeb AnalyticsWebsite Analytics

Properties

Name	Type	Description
name	string	Team name
accessCode	string	Custom access code

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12",
  "$id": "https://raw.githubusercontent.com/api-evangelist/umami/refs/heads/main/json-schema/umami-team-request-schema.json",
  "title": "TeamRequest",
  "description": "Request body for creating or updating a team",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Team name",
      "examples": [
        "Analytics Team"
      ]
    },
    "accessCode": {
      "type": "string",
      "description": "Custom access code",
      "examples": [
        "MYCODE123"
      ]
    }
  },
  "required": [
    "name"
  ]
}