Skip to content

Visitor methods: update, delete

The Visitor Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.

Reference for Visitor, one group of Visitor methods.

Visitor.update

Changes the given properties of a Visitor. Verb page.

TypeScript
interface VisitorVerbs {
  update(input: VisitorUpdateInput, options?: SB.CallOptions): SB.Call<Visitor>
}

Emits Visitor.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Visitor.
firstSeenAtdatetimeWhen the first request arrived.

Returns

OutputTypeRequiredDescription
visitorVisitorrequiredThe Visitor.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

TypeScript
import { $ } from 'startup-builder'

const visitor = await $.Visitor.update({ id: 'visitor_M5gHadysq9', firstSeenAt: '2026-10-22T12:00:00Z' })

Visitor.delete

Deletes a Visitor: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript
interface VisitorVerbs {
  delete(input: VisitorDeleteInput, options?: SB.CallOptions): SB.Call<Visitor>
}

Emits Visitor.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Visitor.

Returns

OutputTypeRequiredDescription
visitorVisitorrequiredThe Visitor.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

TypeScript
import { $ } from 'startup-builder'

const visitor = await $.Visitor.delete({ id: 'visitor_M5gHadysq9' })