Tool to bulk delete persons by PostHog person IDs or distinct IDs. Use when you need to delete multiple persons at once (up to 100 per call). Only events captured before the request will be deleted. Deletion is asynchronous and batched at 5AM UTC every Sunday.
idsarrayA list of PostHog person UUIDs, up to 100 of them. Either ids or distinct_ids is required.
formatstringResponse format (csv or json)
project_idRequiredstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
keep_personbooleanIf true, the person record itself will not be deleted. This is useful if you want to keep the person record for auditing purposes but remove events and recordings associated with them
distinct_idsarrayA list of distinct IDs, up to 100 of them. Either ids or distinct_ids is required.
delete_eventsbooleanIf true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday
delete_recordingsbooleanIf true, a task to delete all recordings associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.