Create a Guest Event

post

https://{region}.verkada.com/v2/guest/guest_events

Creates a Guest event based on a host, guest type, invitees, and specified start and end times. Supports multi-part events by providing multiple time ranges in event_times. A maximum of 30 time spans may be specified.

Guest events allow organizations to pre-register and manage visitors for specific events. See https://help.verkada.com/guest/configuration-and-setup/guest-events for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

event_address

string

The location of the event.

event_description

string

A description of the event.

event_name

string

Defaults to New Event

The name of the Guest event. If not specified, defaults to 'New Event'.

event_times

array of objects

required

length between 1 and 30

A list of start and end times for each event part. If only one time span specified, will be treated as a single day event. A maximum of 30 time spans may be specified and must occur in the future within 1 year.

Event Times*

end_time

string

required

The end time of the event part in ISO 8601 format (e.g., '2025-01-17T22:06:20Z').

start_time

string

required

The start time of the event part in ISO 8601 format (e.g., '2025-01-17T22:06:20Z').

guest_type_id

uuid

required

The unique identifier of the Guest type for this event. Guest types must be eligible and allowed for invites in visibility controls. Guest types can be retrieved with the Guest Type API.

host_id

uuid

required

The unique identifier of the host. Valid hosts can be retrieved with the Guest Host API.

invitees

array of objects

List of invitees for the event.

Invitees

rsvp_enabled

boolean

Defaults to false

Whether a RSVP link should be generated.

site_id

uuid

required

The unique identifier of the Guest site. Valid sites can be retrieved with the Guest Site API.

walk_in_enabled

boolean

Defaults to false

Whether walk-ins are allowed to the event.

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK