About RSVP V2

The RSVP v2 API allows you to access the information about guests who have RSVP’d to an event. This API is helpful for managing guest lists and monitoring check-ins at an event.

When a guest submits an RSVP registration form, a new RSVP is created, and a confirmation email is sent. If a user RSVPs to the waitlist, they will receive an email when additional space becomes available for the event.

With the RSVP v2 API you can:

  • Create RSVP.
  • Find out the attendance status of each guest.
  • Get basic information (name and email) about a guest and the total number of guests for each RSVP.
  • Check in an RSVP guest.

Before you begin

It’s important to note the following points before starting to code:

  • Install the Wix Events & Tickets app from Wix App Market.
  • RSVP registration settings can be configured in the dashboard. The RSVP options can be set to "Yes only" or "Yes and No."
  • Limiting the number of guests is optional. Once the guest list is full, registration will close unless the waitlist feature is enabled.

Use cases

Terminology

  • Guest: An individual invited to the event.
  • RSVP: A response indicating whether a guest plans to attend the event.
  • Check-in: The process of confirming a guest's attendance at the event.
  • Guest list: A summary of all individuals invited to the event.
Did this help?

RSVP V2: Supported Filters and Sorting

The following table shows field support for filters and sorting for the RSVP object:

FieldQuery Filter OperatorsSortable
id$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
revision$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
eventId$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
memberId$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
contactId$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
status$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
totalGuests$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
language$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
locale$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
updatedDate$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
createdDate$eq, $ne, $lt, $lte, $gt, $gte, $in, $nin, hasSome, $existsSortable
anonymized$eq, $ne, $in, $nin, hasSome, $existsSortable
fullyCheckedIn$eq, $ne, $in, $nin, hasSome, $existsSortable

Related content: API Query Language, RSVP Search endpoint

Did this help?

RSVP V2: Sample Use Cases & Flows

This article presents possible use cases and corresponding sample flows that your app can support. It provides a useful starting point as you plan your app's implementation.

Automatically remove guests from a waitlist when additional spots are available

This use case demonstrates how to automate the process of changing a guest's status from WAITLIST to YES when additional spots become available in an event. For example, if someone cancels their RSVP or the guest limit is increased, the RSVP API allows you to update the RSVP status and remove guests from the waitlist. Additionally, you can send automated emails to notify guests about the update.

To change the guest status and send update emails, follow these steps:

  1. On an ongoing basis, listen for Event Updated.

  2. When the event is triggered, retrieve the following values from the event:

    • updatedEvent.currentEntityAsJson.registration.rsvp.limit

    • updatedEvent.currentEntityAsJson.registration.rsvp.waitlistEnabled

    • updatedEvent.currentEntityAsJson.summaries.rsvps.yesCount

      If waitlistEnabled is true, calculate the number of available spots by subtracting yesCount from limit. Save this number.

  3. Search RSVPs by eventId and WAITLIST status. Sort results by the createdDate field in ascending order. Compare the saved number of available spots to the totalGuests field of the RSVP:

    • If the numbers match, update the RSVP status to YES using the Update RSVP method.
    • If they do not match, wait for additional spots to become available.
  4. On an ongoing basis, listen for the RSVP Updated event.

  5. When the event is triggered for your RSVP, send an email to a guest from your marketing tool.

Did this help?

Rsvp Object


Properties
idstringRead-onlyformat GUID

RSVP ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing revision must be used when updating the RSVP.


eventIdstringformat GUID

Event ID to which the RSVP belongs.


createdDatestringRead-onlyformat date-time

Date and time the RSVP was created.


updatedDatestringRead-onlyformat date-time

Date and time the RSVP was update.


memberIdstringformat GUID

Site member ID. You can override the field value when updating the RSVP. Overriding member ID requires the WIX_EVENTS.MANAGE_RSVP permission.


contactIdstringformat GUID

Contact ID of a guest who filled in the RSVP form. See Contacts API for more details.


firstNamestringminLength 1maxLength 50

First name of a guest who filled in the RSVP form.


lastNamestringminLength 1maxLength 50

Last name of a guest who filled in the RSVP form.


emailstringformat EMAILminLength 4maxLength 255

Email of a guest who filled in the RSVP form.


formForm

Event registration form.


statusstring

RSVP response status.


totalGuestsintegerRead-onlyformat int32

Total number of guests per 1 RSVP.


guestListGuestListRead-only

Guest list.


languagestringRead-onlyformat LANGUAGE

Site language code in the ISO 639-1 format.


localestringRead-onlyformat LANGUAGE_TAG

Locale in the IETF BCP 47 format.


fullyCheckedInbooleanRead-only

Whether all guests are checked in.


checkedInGuestCountintegerRead-onlyformat int32

How many guests are checked in.


additionalGuestDetailsAdditionalGuestDetails

Additional guest details.


disableNotificationsboolean

Whether the notifications are disabled.


onlineConferencingLoginOnlineConferencingLoginRead-only

Guest login details for accessing the online conference event.


anonymizedbooleanRead-only

Whether the RSVP is anonymized.


extendedFieldsExtendedFields

Custom field data for the RSVP object.

Note: You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.

Rsvp
JSON
{ "rsvp": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T08:46:46.665Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": null, "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "johndoe@mail.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "YES", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false, "checkInDate": null }, "guestId": 1 } ], "anonymized": false, "language": null, "locale": null, "fullyCheckedIn": false } }
Did this help?

POST

Search Rsvps


Retrieves a list of RSVPs that match the provided search query and optionally performs aggregations on the data queried.

To learn about working with search, see API Query Language, Sorting and Paging, and Field Projection.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v2/rsvps/search

Body Params
searchSearch

Search options. See API Query Language for more details.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
rsvpsArray <Rsvp>

List of RSVPs.


pagingMetadataPagingMetadata

Metadata for the paginated results.


aggregationDataAggregationData

Aggregation data.

Search RSVPs
Request
cURL
curl -X POST 'https://www.wixapis.com/events-rsvps/v2/rsvps/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "search": { "sort": [ { "fieldName": "lastName", "order": "ASC" } ], "filter": { "status": "YES" }, "cursorPaging": { "limit": 1 } }, "fields": [ "DETAILS", "FORM" ] }'
Response
JSON
{ "rsvps": [ { "id": "d706f4a4-f533-4760-8b53-c26cdbeb9ab0", "revision": "1", "eventId": "97dacca6-9ec0-4b7d-892a-33841b9d7bac", "createdDate": "2024-10-25T10:35:38.781Z", "updatedDate": "2024-10-25T10:35:38.781Z", "memberId": null, "contactId": "6ed64984-f408-41da-9c4c-69ab800f6674", "firstName": "John", "lastName": "Doe", "email": null, "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "john.doe@test.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "YES", "totalGuests": 1, "guestList": { "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false, "checkInDate": null }, "guestId": 1 } ] }, "language": null, "locale": null, "fullyCheckedIn": false, "checkedInGuestCount": 0, "additionalGuestDetails": null, "disableNotifications": false, "onlineConferencingLogin": null, "anonymized": false, "emailDomain": null, "extendedFields": null } ], "pagingMetadata": { "count": 1, "cursors": { "next": "4b1061c51b6d38c7fa08250aa9c126684966faa9.EloKCGxhc3ROYW1lGk4aTDBLbldsRW5HRG82VnF4TFdVU0R8b05NY2VHV2dFSGJsMEpJZ1VlWkZYVG1nfHp0YVZaanZYanhlZm0yMmhlRUlSNkVsSk9wfDcwTDgSCRoFGgMxLjAgARIqGiYaJGQ3MDZmNGE0LWY1MzMtNDc2MC04YjUzLWMyNmNkYmViOWFiMCABIhEKDwoGc3RhdHVzEgUaA1lFU1ABWhpuaWxlL3dpeC5ldmVudHMudjIucnN2cC12MWImCiRiZDZjNDZmOC0zNGJkLTRkOWMtODc4NC0zODgxOWE5MWEzMjA", "prev": null }, "hasNext": true }, "aggregationData": null }
Did this help?

POST

Query Rsvps


Retrieves a list of RSVPs, given the provided paging, filtering, and sorting. Query RSVPs runs with these defaults, which you can override:

  • createdDate is sorted in ASC order
  • paging.limit is 100
  • paging.offset is 0

For field support for filters and sorting, see RSVP v2: Supported Filters and Sorting. To learn about working with Query endpoints, see API Query Language.

Note: This method is quite slow. We suggest you using the following filter pairs for the most optimal speed:

  • eventId and status
  • eventId and fullyCheckedIn
  • eventId and memberId
  • eventId and contactId
  • eventId and createdDate
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v2/rsvps/query

Body Params
queryQuery

Query options. See API Query Language for more details.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
rsvpsArray <Rsvp>

List of RSVPs.


pagingMetadataPagingMetadata

Metadata for the paginated results.

Query RSVP with the DETAILS and CONTACT_DETAILS fields
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/rsvps/query' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "query": { "filter": { "eventId": "e1beee02-f915-4414-9b25-3082aaa89c19" }, "sort": [ { "order": "DESC", "fieldName": "createdDate" } ], "cursorPaging": { "limit": 1 } }, "fields": [ "DETAILS", "CONTACT_DETAILS" ] }'
Response
JSON
{ "rsvps": [ { "id": "bd1e6654-e0b3-45a0-a8ac-07197a2a4eb0", "revision": "1", "eventId": "e1beee02-f915-4414-9b25-3082aaa89c19", "createdDate": "2024-12-13T11:06:27.052Z", "updatedDate": "2024-12-13T11:06:27.052Z", "contactId": "481f8f6b-7a8f-4ef1-8b86-aa3d980314b6", "firstName": "Jon", "lastName": "Doe", "email": "johndoe@mail.com", "status": "YES", "totalGuests": 1, "guestList": { "guests": [ { "index": 0, "fullName": "Jon Doe", "checkInDetails": { "checkedIn": false }, "guestId": 1 } ] }, "fullyCheckedIn": false, "checkedInGuestCount": 0, "additionalGuestDetails": { "guestCount": 0, "guestNames": [] }, "disableNotifications": true, "anonymized": false, "emailDomain": "mail.com" } ], "pagingMetadata": { "count": 1, "cursors": { "next": "041f2b15f6c732c788f1c239526ecb6432b51f88.EjUqMwoxCgdldmVudElkEiYaJGUxYmVlZTAyLWY5MTUtNDQxNC05YjI1LTMwODJhYWE4OWMxORotCgxfY3JlYXRlZERhdGUQARobKhkKFwoKJHRpbWVzdGFtcBIJEQDA9iz7O3lCIiRiZDFlNjY1NC1lMGIzLTQ1YTAtYThhYy0wNzE5N2EyYTRlYjA" }, "hasNext": true } }
Did this help?

POST

Count Rsvps


Counts RSVPs given the provided filtering and searching.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v2/rsvps/count

Body Params
filterstruct

Filter object in the following format: "filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} } Example of operators: $eq, $ne, $lt, $lte, $gt, $gte, $in, $hasSome, $hasAll, $startsWith, $contains


searchSearch

Search details.

Response Object
countinteger

Number of RSVPs.

Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/rsvps/count' \ -H 'Authorization: <AUTH TOKEN>'\ -H 'Content-Type: application/json' \ -d '{ "filter": { "eventId": "2c0eab1-b7a0-4ec2-9fb6-db76f76ee488" } }'
Response
JSON
{ "count": 23 }
Did this help?

GET

Get Rsvp


Retrieves RSVP by ID.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/events/v2/rsvps/{rsvpId}

Path Params
rsvpIdstringRequired

RSVP ID.

Query Params
fieldsArray <string>

Predefined sets of fields to return.

Response Object
rsvpRsvp

The requested RSVP.

Get RSVP with the DETAILS, FORM and CONTACT_DETAILS fieldsets
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/rsvps/8c30fd39-c927-49c5-95d4-dc75c991681d?fields=DETAILS&fields=FORM&fields=CONTACT_DETAILS' \ -H 'Authorization: <AUTH TOKEN>' \
Response
JSON
{ "rsvp": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T08:46:46.665Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": null, "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "johndoe@mail.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "YES", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false, "checkInDate": null }, "guestId": 1 } ], "anonymized": false, "language": null, "locale": null, "fullyCheckedIn": false }, "calendarLinks": null }
Did this help?

DELETE

Delete Rsvp


Permanently deletes an RSVP.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Endpoint
DELETE
https://www.wixapis.com/events/v2/rsvps/{rsvpId}

Path Params
rsvpIdstringRequired

ID of the RSVP to delete.

Response Object
Returns an empty object.
Delete RSVP
Request
cURL
curl -X DELETE 'https://www.wixapis.com/events/v2/rsvps/04978771-573e-40d8-b644-ce99ac49706e' \ -H 'Authorization: <AUTH TOKEN>' \
Response
JSON
{}
Event TriggersThis method triggers the following events:
Did this help?

POST

Create Rsvp


Creates RSVP.

To create RSVP with multiple guests, you have to specify the additionalGuests and guestNames fields.

Endpoint
POST
https://www.wixapis.com/events/v2/rsvps

Body Params
rsvpRsvpRequired

RSVP info.


optionsOptions

RSVP options.
The WIX_EVENTS.MANAGE_RSVP permission is required.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
rsvpRsvp

Created RSVP.


calendarLinksCalendarLinks

"Add to calendar" links.

Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/rsvps' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "rsvp": { "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "form": { "inputValues": [ { "inputName": "firstName", "value": "John" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "johndoe@mail.com" } ] }, "status": "YES" } }'
Response
JSON
{ "rsvp": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T08:46:46.665Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": null, "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "johndoe@mail.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "YES", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false, "checkInDate": null }, "guestId": 1 } ], "anonymized": false, "language": null, "locale": null, "fullyCheckedIn": false }, "calendarLinks": null }
Errors
400Invalid Argument

There are 4 errors with this status code:

428Failed Precondition

There are 8 errors with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

PATCH

Update Rsvp


Updates RSVP.

Each time the RSVP is updated, revision increments by 1. The existing revision must be included when updating the RSVP. This ensures you're working with the latest RSVP and prevents unintended overwrites.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/events/v2/rsvps/{rsvp.id}

Path Params
rsvp.idstringRequired

RSVP ID.

Body Params
rsvpRsvpRequired

RSVP to update.


optionsOptions

RSVP options.
The WIX_EVENTS.MANAGE_RSVP permission is required to pass these fields.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
rsvpRsvp

Updated RSVP.

Update RSVP
Request
cURL
curl -X PATCH 'https://www.wixapis.com/events/v2/rsvps/8c30fd39-c927-49c5-95d4-dc75c991681d' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "rsvp": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "form": { "inputValues": [ { "inputName": "firstName", "value": "John" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "johndoe@mail.com" } ] }, "status": "NO" } "fieldmask": { "status" } }'
Response
JSON
{ "rsvp": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T08:46:46.665Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": null, "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "johndoe@mail.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "NO", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false, "checkInDate": null }, "guestId": 1 } ], "anonymized": false, "language": null, "locale": null, "fullyCheckedIn": false }, "calendarLinks": null }
Errors
400Invalid Argument

There are 4 errors with this status code:

428Failed Precondition

There are 4 errors with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

PATCH

Bulk Update Rsvps


Updates multiple RSVPs.

You can update up to 100 RSVPs per request.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/events/v2/bulk/rsvps/update

Body Params
rsvpsArray <MaskedRsvp>RequiredminItems 1maxItems 100

RSVPs to update.


returnEntityboolean

Whether to return the whole rsvp object in the response. If false, only metadata is returned.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.


optionsOptions

RSVP options.
The WIX_EVENTS.MANAGE_RSVP permission is required to pass these fields.

Response Object
resultsArray <BulkRsvpResult>minItems 1maxItems 100

Response of bulk update.


bulkActionMetadataBulkActionMetadata

Response metadata.

Bulk Update RSVPs
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/bulk/rsvps/update' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "rsvps": [ { "rsvp" : { "id": "27e40159-9cf4-40e2-b8d9-765dc70c350a", "revision": "1", "status": "NO" }, "rsvp" : { "id": "b8955360-5d3e-49d3-b72f-37114133e6f9", "revision": "1", "status": "NO" } } ], "returnEntity": true, "fields": [], "options": {} }'
Response
JSON
{ "results": [ { "itemMetadata": { "id": "b8955360-5d3e-49d3-b72f-37114133e6f9", "originalIndex": 0, "success": true }, "rsvp": { "id": "b8955360-5d3e-49d3-b72f-37114133e6f9", "revision": "3", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": "c64c558f-ed41-4395-b820-f8dd66c31702", "status": "NO", "anonymized": false } }, { "itemMetadata": { "id": "27e40159-9cf4-40e2-b8d9-765dc70c350a", "originalIndex": 0, "success": true }, "rsvp": { "id": "27e40159-9cf4-40e2-b8d9-765dc70c350a", "revision": "3", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": "c64c558f-ed41-4395-b820-f8dd66c31702", "status": "NO", "anonymized": false } } ], "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 0, "undetailedFailures": 0 } }
Errors
400Invalid Argument

There are 2 errors with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

POST

Bulk Delete Rsvps By Filter


Permanently deletes multiple RSVPs by filter.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v2/bulk/rsvps/delete-by-filter

Body Params
filterstructRequired

Filter object.


searchSearch

Search details.

Response Object
jobIdstringformat GUID

Job ID. Pass this ID to Get Async Job to retrieve job details and metadata.

Bulk delete RSVPs by status
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/bulk/rsvps/delete-by-filter' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ "filter": { "status": "NO" } }'
Response
JSON
{ "jobId": "b551071c-0688-4c43-84fd-3f7f106c7a39" }
Errors
400Invalid Argument

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

POST

Check In Rsvp Guests


Checks in RSVP guests.

You can check in up to 11 guests per request.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v2/rsvps/{rsvpId}/check-in

Path Params
rsvpIdstringRequired

ID of RSVP to check-in.

Body Params
guestIdsArray <integer>minimum 1minItems 1maxItems 11

IDs of guests to check-in.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
rsvpRsvp

Updated RSVP.

Check in guests
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/rsvps/8c30fd39-c927-49c5-95d4-dc75c991681d/check-in' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "guestIds": [1] }'
Response
JSON
{ "rsvp": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T12:53:17.862Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": null, "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "johndoe@mail.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "YES", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": true, "checkInDate": "2023-10-20T12:53:17.760Z" }, "guestId": 1 } ], "anonymized": false, "language": null, "locale": null, "fullyCheckedIn": true }, "calendarLinks": null }
Errors
400Invalid Argument

There is 1 error with this status code:

428Failed Precondition

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

POST

Cancel Rsvp Guests Check In


Cancels the check-in of RSVP guests.

If the request body is empty, cancels all check-ins from the RSVP. After the cancellation, the guests.checkInDate value becomes empty.

You can cancel check-in of up to 11 guests per request.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/events/v2/rsvps/{rsvpId}/cancel-check-in

Path Params
rsvpIdstringRequired

ID of RSVP to cancel check-in.

Body Params
guestIdsArray <integer>minimum 1minItems 1maxItems 11

IDs of guests to check-in.


fieldsArray <string>maxItems 3

Predefined sets of fields to return.

Response Object
rsvpRsvp

Updated RSVP.

Cancel guests check in
Request
cURL
curl -X POST 'https://www.wixapis.com/events/v2/rsvps/8c30fd39-c927-49c5-95d4-dc75c991681d/cancel-check-in' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d '{ "guestIds": [1] }'
Response
JSON
{ "rsvp": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T13:04:01.957Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "contactId": null, "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "lastName", "value": "Doe", "values": [], "number": null, "dateTime": null, "address": null }, { "inputName": "email", "value": "johndoe@mail.com", "values": [], "number": null, "dateTime": null, "address": null } ] }, "status": "YES", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": true, "checkInDate": null }, "guestId": 1 } ], "anonymized": false, "language": null, "locale": null, "fullyCheckedIn": true }, "calendarLinks": null }
Errors
400Invalid Argument

There is 1 error with this status code:

428Failed Precondition

There is 1 error with this status code:

See the entire list and learn more about Wix errors.

Event TriggersThis method triggers the following events:
Did this help?

GET

List Rsvp Summary


Retrieves RSVP summary by ID.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/events/v2/rsvps/summaries

Query Params
eventIdArray <string>Required

Event ID.

Response Object
summariesArray <RsvpSummary>

List of RSVP summary.

List RSVP Summary for events
Request
cURL
curl -X GET 'https://www.wixapis.com/events/v2/rsvps/summaries?eventId=56b4ea0a-7789-40e8-81b8-10e8d6b8bb88&eventId=15872fbe-e584-4004-b095-d21ed2778f40' \ -H 'Authorization: <AUTH TOKEN>' \
Response
JSON
{ "summaries": [ { "eventId": "15872fbe-e584-4004-b095-d21ed2778f408", "yesGuestCount": 10, "noGuestCount": 3, "waitlistGuestCount": 1, "totalRsvpCount": 14 }, { "eventId": "56b4ea0a-7789-40e8-81b8-10e8d6b8bb88", "yesGuestCount": 4, "noGuestCount": 0, "waitlistGuestCount": 0, "totalRsvpCount": 4 } ] }
Did this help?

Rsvp Created


Triggered when RSVP is created.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.v2.rsvp.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventCreatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.v2.rsvp_created", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

RsvpCreated
JSON
{ "id": "baf73064-6fd1-4b7f-9326-ba07880de1e5", "entityFqdn": "wix.events.rsvps.v2.rsvp", "slug": "created", "entityId": "887ae285-ad3e-457c-a9a6-d62f756222cf", "createdEvent": { "entityAsJson": { "id": "887ae285-ad3e-457c-a9a6-d62f756222cf", "revision": "1", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T11:42:57.161Z", "updatedDate": "2023-10-20T11:42:57.161Z", "memberId": "b51a59c6-6f3d-11ee-b962-0242ac120002", "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [] }, { "inputName": "lastName", "value": "Doe", "values": [] }, { "inputName": "email", "value": "johndoe@mail.com", "values": [] }, { "inputName": "additionalGuests", "value": "2", "values": [] }, { "inputName": "guestNames", "value": "", "values": ["Patsy McBride", "Randy Ramirez"] } ] }, "status": "YES", "totalGuests": 3, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false }, "guestId": 1 }, { "index ": 1, "fullName": "Patsy McBride", "checkInDetails": { "checkedIn": false }, "guestId": 2 }, { "index": 2, "fullName": "Randy Ramirez", "checkInDetails": { "checkedIn": false }, "guestId": 3 } ], "anonymized": false, "fullyCheckedIn": false } }, "eventTime": "2023-10-20T11:42:57.172657Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "1" }
Did this help?

Rsvp Deleted


Triggered when RSVP is deleted.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.v2.rsvp.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.v2.rsvp_deleted", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

RsvpDeleted
JSON
{ "id": "e16b4607-6f5c-4bcc-8d5c-bea99019ea96", "entityFqdn": "wix.events.rsvps.v2.rsvp", "slug": "deleted", "entityId": "04978771-573e-40d8-b644-ce99ac49706e", "deletedEvent": { "movedToTrash": true }, "eventTime": "2023-10-20T13:17:52.667997Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "2" }
Did this help?

Rsvp Updated


Triggered when RSVP is updated.

Permissions
Manage Events - all permissions
Read Events - all read permissions
Manage Guest List
Read Event Tickets and Guest List
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.events.v2.rsvp.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventUpdatedEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{ "data": { "eventType": "wix.events.v2.rsvp_updated", "instanceId": "<app-instance-id>", "data": "<stringified-JSON>", // The identity field is sent as a stringified JSON "identity": { "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR "memberId": "<memberId>", // in case of MEMBER "wixUserId": "<wixUserId>", // in case of WIX_USER "appId": "<appId>" // in case of APP } } }

RsvpUpdated
JSON
{ "id": "2e82070f-56be-400f-ad51-f1b7a3a6900f", "entityFqdn": "wix.events.rsvps.v2.rsvp", "slug": "updated", "entityId": "8c30fd39-c927-49c5-95d4-dc75c991681d", "updatedEvent": { "currentEntityAsJson": { "id": "8c30fd39-c927-49c5-95d4-dc75c991681d", "revision": "3", "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "createdDate": "2023-10-20T08:46:46.665Z", "updatedDate": "2023-10-20T13:04:01.957Z", "memberId": "8a8b9b73-4da8-47a5-8268-4396e68a0605", "firstName": "John", "lastName": "Doe", "email": "johndoe@mail.com", "form": { "inputValues": [ { "inputName": "firstName", "value": "John", "values": [] }, { "inputName": "lastName", "value": "Doe", "values": [] }, { "inputName": "email", "value": "johndoe@mail.com", "values": [] } ] }, "status": "YES", "totalGuests": 1, "guests": [ { "index": 0, "fullName": "John Doe", "checkInDetails": { "checkedIn": false }, "guestId": 1 } ], "anonymized": false, "fullyCheckedIn": false } }, "eventTime": "2023-10-20T13:04:01.972754Z", "triggeredByAnonymizeRequest": false, "entityEventSequence": "3" }
Did this help?