VEverkada
Events

Create a Guest Event

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.

post/v2/guest/guest_events

Request

  • Base URL
    https://api.verkada.com
  • URL
    https://api.verkada.com/v2/guest/guest_events
  • Auth
    • API key in header x-verkada-auth
    • or API key in header x-api-key

Request body

event_addressstring

The location of the event.

event_descriptionstring

A description of the event.

event_namestring

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

guest_type_idstring 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_idstring uuid required

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

rsvp_enabledboolean

Whether a RSVP link should be generated.

site_idstring uuid required

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

walk_in_enabledboolean

Whether walk-ins are allowed to the event.

Response

OK

end_timestring required

The ending time of the event. This will be for the last event part of multi-part events in RFC 3339 format (e.g., '2025-01-17T21:06:20+00:00').

event_addressstring

The location of the event taking place.

event_descriptionstring

A description of the Guest event.

event_namestring

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

event_sourcestring required

The source at which the event was created from.

guest_event_idstring uuid required

The unique identifier of the Guest event.

guest_type_idstring uuid

The unique identifier of the Guest type for this event. Guest types can be retrieved with the Guest Type API.

host_idstring uuid required

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

rsvp_linkstring

The RSVP link of the event if generated.

site_idstring uuid required

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

start_timestring required

The starting time of the event. This will be for the first event part of multi-part events in RFC 3339 format (e.g., '2025-01-17T21:06:20+00:00').

statusstring required

The status of the event (active, canceled or rescheduled).

walk_in_enabledboolean required

Whether walk-ins are allowed to the event.

Changes

No recorded changes to this operation across all 1 revision of this API.