Skip to main content
POST
Create a new guest

Authorizations

x-api-key
string
header
required

Body

application/json
event
string
required

Event ID

properties
object
required

Guest required properties and any custom properties defined for the event

extras
object

Optional additional guest data

Response

Guest created 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: