Introduction
With the RSVP API you can access the information on guests who have RSVP'ed to an event. This API is useful for managing guests lists and to see who has already checked into an event.
When a guest responds to a RSVP registration form, a new RSVP is created and a confirmation email is sent.
If you limit the number of guests, the registration will close once the guest list reaches capacity. You have the option to enable a waitlist, allowing site visitors to sign up and receive email notifications when additional space becomes available for the event.
With the RSVP API you can:
- Create, delete, and update RSVPs.
- Check-in guests.
- Get the information about RSVPs.
Terminology
- Guest: The individual who has been invited to the event.
- RSVP: A response from the guest indicating whether they plan to attend the event.
- Check-in: The process of verifying a guest's attendance at the event.
- Guest list: A summary of all guests who have been invited to the event.
- Event: A gathering organized by an individual or business for a group of people.
Setup
To use the Rsvp API, install the @wix/events
package using npm or Yarn:
1npm install @wix/events
or
1yarn add @wix/events
Then import { rsvp }
from @wix/events
:
1import { rsvp } from '@wix/events'
Updates statuses of multiple RSVPs.
Permission Scopes
For app development, you must have one of the following permission scopes:function bulkUpdateRsvp(eventId: string, options: BulkUpdateRsvpOptions): Promise<BulkUpdateRsvpResponse>
Event ID to which RSVP belongs.
Optional fields.
Checks-in an RSVP.
function checkInRsvp(eventId: string, options: CheckInRsvpOptions): Promise<CheckInRsvpResponse>
Event ID to which RSVP belongs.
Optional fields.
Creates an RSVP, associated with a contact of the site.
function createRsvp(options: CreateRsvpOptions): Promise<CreateRsvpResponse>
Optional fields.
Deletes an RSVP.
Permission Scopes
For app development, you must have one of the following permission scopes:function deleteRsvp(eventId: string, options: DeleteRsvpOptions): Promise<void>
Event ID to which RSVP belongs.
Optional fields.
Deletes an RSVP check-in.
function deleteRsvpCheckIn(eventId: string, options: DeleteRsvpCheckInOptions): Promise<DeleteRsvpCheckInResponse>
Event ID to which RSVP belongs.
Optional fields.
Retrieves an RSVP.
Permission Scopes
For app development, you must have one of the following permission scopes:function getRsvp(rsvpId: string, options: GetRsvpOptions): Promise<Rsvp>
RSVP ID.
Optional fields.
Retrieves a list of up to 100 RSVPs.
Permission Scopes
For app development, you must have one of the following permission scopes:function listRsvp(options: ListRsvpOptions): Promise<ListRsvpResponse>
Optional fields.
Retrieves a list of up to 100 RSVPs.
Permission Scopes
For app development, you must have one of the following permission scopes:function queryRsvp(options: QueryRsvpOptions): Promise<QueryRsvpResponse>
Optional fields.
Updates an RSVP.
Permission Scopes
For app development, you must have one of the following permission scopes:function updateRsvp(rsvpId: string, eventId: string, options: UpdateRsvpOptions): Promise<UpdateRsvpResponse>
RSVP ID.
Event ID to which RSVP belongs.
Optional fields.