Skip to main content
DELETE
Delete a guest

Authorizations

x-api-key
string
header
required

Workspace API key. Keys are scoped: a full key reaches every route below, while a logs:read key only reaches GET /v1/logs and gets 403 everywhere else. Keys minted before scopes existed count as full.

Path Parameters

_id
string
required

Guest ID to delete.

Query Parameters

event
string
required

Associated event ID.

Response

Guest deleted successfully.

_id
string
required

Guest ID

event
string
required

Event ID

status
object
required

Guest status information including confirmation, attendance, consents and check-in details

Example:
properties
object
required

Guest properties including default required fields and any custom properties defined for the event

Example:
confirmedAt
string<date-time> | null

Date and time when the guest was confirmed

attendedAt
string<date-time> | null

Date and time when the guest attended the event

starred
boolean
default:false

Indicates if the guest is starred

extras
object

Optional additional guest data

Example:
wallet
object

Mobile wallet bookkeeping, maintained by Attendu