Mixpanel · Schema

GroupUpdate

AnalyticsData AnalysisEvent TrackingProduct AnalyticsUser Behavior

Properties

Name Type Description
$token string Mixpanel project token
$group_key string The group key (e.g., company)
$group_id string The group identifier value
$set object Properties to set on the group profile
$set_once object Properties to set only if not already set
$unset array Property names to remove from the group profile
$delete string Set to empty string to delete the group profile
View JSON Schema on GitHub

JSON Schema

mixpanel-groupupdate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GroupUpdate",
  "title": "GroupUpdate",
  "type": "object",
  "required": [
    "$token",
    "$group_key",
    "$group_id"
  ],
  "properties": {
    "$token": {
      "type": "string",
      "description": "Mixpanel project token"
    },
    "$group_key": {
      "type": "string",
      "description": "The group key (e.g., company)"
    },
    "$group_id": {
      "type": "string",
      "description": "The group identifier value"
    },
    "$set": {
      "type": "object",
      "additionalProperties": true,
      "description": "Properties to set on the group profile"
    },
    "$set_once": {
      "type": "object",
      "additionalProperties": true,
      "description": "Properties to set only if not already set"
    },
    "$unset": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Property names to remove from the group profile"
    },
    "$delete": {
      "type": "string",
      "description": "Set to empty string to delete the group profile"
    }
  }
}