Skip to content

by Startups.Studio

Visitor.forget

POST /{namespace}/visitors/{visitor}/forget

Forget masks a person’s captured data across every Event and Recording and suppresses further capture, keeping the records.

Noun: Visitor
Mode: do
Event: Visitor.forgotten

You, to your agent

Forget the latest visitor.

curl -X POST https://api.sb/routewise.dev/visitors/visitor_1/forget \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"request":"Example request"}'

import { $ } from 'startup-builder'

const visitor = await $.Visitor.forget({ visitor: 'visitor_1', request: 'Example request' })

npx startup-builder do Visitor.forget --json '{"visitor":"visitor_1","request":"Example request"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Visitor.forget({ visitor: 'visitor_1', request: 'Example request' })"
  }
}

Inputs

Input	Type	Required	Description
`visitor`	Visitor	required	The Visitor to forget.
`request`	`text`	required	The privacy request it answers.

Outputs

Output	Type	Required	Description
`visitor`	Visitor	required	The Visitor, masked.

Effects

Emits Visitor.forgotten.
Performed by the Privacy Officer.
One-way (customer): it waits out its delay window, and runs in the send and do modes.
Masks identifying fields in place; records are kept forever and nothing is erased.
Stops capture for the person on every Domain the Startup serves.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Visitor.forget

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (customer)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Visitor.delete

Previous Page

Visitor.get

Next Page