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.
Did this help?

Setup

@wix/events

To use the Rsvp API, install the @wix/events package using npm or Yarn:

Copy
npm install @wix/events

or

Copy
yarn add @wix/events

Then import { rsvp } from @wix/events:

Copy
import { rsvp } from "@wix/events";
Did this help?

bulkUpdateRsvp( )

Deprecated

This method has been replaced with Bulk Update Rsvps, and will be removed on June 30, 2025.

Updates statuses of multiple RSVPs.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Events - all permissions
Manage Guest List
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function bulkUpdateRsvp(
  eventId: string,
  options: BulkUpdateRsvpOptions,
): Promise<BulkUpdateRsvpResponse>;
Method Parameters
eventIdstringRequired

Event ID to which RSVP belongs.

optionsBulkUpdateRsvpOptions

Optional fields.

Returns
Return Type:Promise<BulkUpdateRsvpResponse>
JavaScript
import { rsvp } from "@wix/events";

async function bulkUpdateRsvp(eventId, options) {
  const response = await rsvp.bulkUpdateRsvp(eventId, options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

checkInRsvp( )

Deprecated

This method has been replaced with Check In Rsvp Guests, and will be removed on June 30, 2025.

Checks-in an RSVP.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Method Declaration
Copy
function checkInRsvp(
  eventId: string,
  options: CheckInRsvpOptions,
): Promise<CheckInRsvpResponse>;
Method Parameters
eventIdstringRequired

Event ID to which RSVP belongs.

optionsCheckInRsvpOptions

Optional fields.

Returns
Return Type:Promise<CheckInRsvpResponse>
JavaScript
import { rsvp } from "@wix/events";

async function checkInRsvp(eventId, options) {
  const response = await rsvp.checkInRsvp(eventId, options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

createRsvp( )

Deprecated

This method has been replaced with Create Rsvp, and will be removed on June 30, 2025.

Creates an RSVP, associated with a contact of the site.

Permissions
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function createRsvp(options: CreateRsvpOptions): Promise<CreateRsvpResponse>;
Method Parameters
optionsCreateRsvpOptions

Optional fields.

Returns
Return Type:Promise<CreateRsvpResponse>
JavaScript
import { rsvp } from "@wix/events";

async function createRsvp(options) {
  const response = await rsvp.createRsvp(options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

deleteRsvp( )

Deprecated

This method has been replaced with Delete Rsvp, and will be removed on June 30, 2025.

Deletes an RSVP.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Events - all permissions
Manage Guest List
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function deleteRsvp(eventId: string, options: DeleteRsvpOptions): Promise<void>;
Method Parameters
eventIdstringRequired

Event ID to which RSVP belongs.

optionsDeleteRsvpOptions

Optional fields.

JavaScript
import { rsvp } from "@wix/events";

async function deleteRsvp(eventId, options) {
  const response = await rsvp.deleteRsvp(eventId, options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?