Skip to main content
POST
Check in a guest

Authorizations

x-api-key
string
header
required

Path Parameters

_id
string
required

Guest ID to check in.

Body

application/json
eventId
string
required

ID of the event

incrementBy
integer
default:1

Number to increment attendance by

method
enum<string>

Method used for check-in

Available options:
qrScan,
manual
zoneId
string

ID of the zone if checking into specific zone

Response

Guest checked in 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: