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.
Was this helpful?
Yes
No

Setup

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

Copy
1
npm install @wix/events

or

Copy
1
yarn add @wix/events

Then import { rsvp } from @wix/events:

Copy
1
import { rsvp } from '@wix/events'
Was this helpful?
Yes
No
bulkUpdateRsvp( )

Updates statuses of multiple RSVPs.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Guest List
Learn more about permission scopes.
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>
Was this helpful?
Yes
No
checkInRsvp( )

Checks-in an RSVP.

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>
Was this helpful?
Yes
No
createRsvp( )

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

Copy
function createRsvp(options: CreateRsvpOptions): Promise<CreateRsvpResponse>
Method Parameters
optionsCreateRsvpOptions
Optional fields.
Returns
Return Type:Promise<CreateRsvpResponse>
Was this helpful?
Yes
No
deleteRsvp( )

Deletes an RSVP.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Guest List
Learn more about permission scopes.
Copy
function deleteRsvp(eventId: string, options: DeleteRsvpOptions): Promise<void>
Method Parameters
eventIdstringRequired
Event ID to which RSVP belongs.
optionsDeleteRsvpOptions
Optional fields.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
deleteRsvpCheckIn( )

Deletes an RSVP check-in.

Copy
function deleteRsvpCheckIn(eventId: string, options: DeleteRsvpCheckInOptions): Promise<DeleteRsvpCheckInResponse>
Method Parameters
eventIdstringRequired
Event ID to which RSVP belongs.
optionsDeleteRsvpCheckInOptions
Optional fields.
Returns
Return Type:Promise<DeleteRsvpCheckInResponse>
Was this helpful?
Yes
No
getRsvp( )

Retrieves an RSVP.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Events - all permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about permission scopes.
Copy
function getRsvp(rsvpId: string, options: GetRsvpOptions): Promise<Rsvp>
Method Parameters
rsvpIdstringRequired
RSVP ID.
optionsGetRsvpOptions
Optional fields.
Returns
Return Type:Promise<Rsvp>
Was this helpful?
Yes
No
listRsvp( )

Retrieves a list of up to 100 RSVPs.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Events - all permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about permission scopes.
Copy
function listRsvp(options: ListRsvpOptions): Promise<ListRsvpResponse>
Method Parameters
optionsListRsvpOptions
Optional fields.
Returns
Return Type:Promise<ListRsvpResponse>
Was this helpful?
Yes
No
queryRsvp( )

Retrieves a list of up to 100 RSVPs.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Events - all read permissions
Manage Events - all permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about permission scopes.
Copy
function queryRsvp(options: QueryRsvpOptions): Promise<QueryRsvpResponse>
Method Parameters
optionsQueryRsvpOptions
Optional fields.
Returns
Return Type:Promise<QueryRsvpResponse>
Was this helpful?
Yes
No
updateRsvp( )

Updates an RSVP.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Guest List
Learn more about permission scopes.
Copy
function updateRsvp(rsvpId: string, eventId: string, options: UpdateRsvpOptions): Promise<UpdateRsvpResponse>
Method Parameters
rsvpIdstringRequired
RSVP ID.
eventIdstringRequired
Event ID to which RSVP belongs.
optionsUpdateRsvpOptions
Optional fields.
Returns
Return Type:Promise<UpdateRsvpResponse>
Was this helpful?
Yes
No