PostHog · Schema

PersonBulkDeleteRequest

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name Type Description
ids array A list of PostHog person UUIDs to delete (max 1000).
distinct_ids array A list of distinct IDs whose associated persons will be deleted (max 1000).
delete_events boolean If true, queue deletion of all events associated with these persons.
delete_recordings boolean If true, queue deletion of all recordings associated with these persons.
keep_person boolean If true, keep the person records but delete their events and recordings.
View JSON Schema on GitHub

JSON Schema

posthog-personbulkdeleterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PersonBulkDeleteRequest",
  "title": "PersonBulkDeleteRequest",
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of PostHog person UUIDs to delete (max 1000)."
    },
    "distinct_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of distinct IDs whose associated persons will be deleted (max 1000)."
    },
    "delete_events": {
      "type": "boolean",
      "default": false,
      "description": "If true, queue deletion of all events associated with these persons."
    },
    "delete_recordings": {
      "type": "boolean",
      "default": false,
      "description": "If true, queue deletion of all recordings associated with these persons."
    },
    "keep_person": {
      "type": "boolean",
      "default": false,
      "description": "If true, keep the person records but delete their events and recordings."
    }
  }
}