Skip to content

tracking_profiles_delete

GDPR erasure: permanently delete a person and their events from Postgres and record an erasure request.

Tool

tracking_profiles_delete

GDPR erasure: permanently delete a person and their events from Postgres and record an erasure request.

GDPR erasure: permanently delete a person and their events from Postgres and record an erasure request. Archived events are flagged as a deletion gap.

Behavior

HTTP
DELETE /tracking/profiles/:profileId

Arguments

Name
Type
Required
Description
profileId
string
•
The profile id (uuid)

Response

Field
Type
Always
Description
ok
boolean
•
Always true: the response only exists when the erasure ran. A failure arrives as an error, not as ok=false.
archive
object
•
What happened to the archived copy of the events. Postgres is erased synchronously; the archive is not, and this says so out loud.
deleted
object
•
How much was actually destroyed, by kind. Worth recording: it is the evidence that the erasure did something.
profileId
string
•
The person who was erased. Nothing else of them remains, so this is all there is left to name them by.
requestId
string
•
This erasure attempt. The completion event carries the same value under the same name, so a step recognises its own completion even when another workflow is erasing the same person at the same moment.
recordings
object
•
What happened to the session recordings of this person. Unlike the events archive, they are deleted per person.

Try it

GDPR erasure: permanently delete a person and their events from Postgres and record an erasure request.

When to use

GDPR erasure: permanently delete a person and their events from Postgres and record an erasure request. Archived events are flagged as a deletion gap.

Example

Ask your agent something like this:

GDPR erasure: permanently delete a person and their events from Postgres and record an erasure request.

The agent will invoke tracking_profiles_delete with these arguments:

{
  "profileId": "<profileId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select