Skip to main content
POST
devices.visitor.delete

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by a visitor row of devices.visitors.list or devices.events.search.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
confirm
boolean
required

Confirm permanent deletion; required, with no default.

Response

The result

requested
boolean
required

Deletion accepted.

status
string
required

Deletion is queued; event removal may take up to 24 hours and older data follows retention.

Allowed value: "pending"