provider persons POST /api/environments/{environment_id}/persons/bulk_delete/
@utdk/posthog /api/environments/{environment_id}/persons/bulk_delete/
environments_persons_bulk_delete_create
This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted.
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
format query
enum: csv, json

Try it

Authentication
Configure credentials for PostHog API
environmentsPersonsBulkDeleteCreate
POST/api/environments/{environment_id}/persons/bulk_delete/
This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

Input

A list of PostHog person UUIDs to delete (max 1000).

A list of distinct IDs whose associated persons will be deleted (max 1000).

If true, queue deletion of all events associated with these persons.

If true, queue deletion of all recordings associated with these persons.

If true, keep the person records but delete their events and recordings.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsPersonsBulkDeleteCreate({
  "delete_events": false,
  "delete_recordings": false,
  "keep_person": false
})