cancelRsvpGuestsCheckIn( )

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
  • 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 cancelRsvpGuestsCheckIn(
  rsvpId: string,
  options: CancelRsvpGuestsCheckInOptions,
): Promise<CancelRsvpGuestsCheckInResponse>;
Method Parameters
rsvpIdstringRequired

ID of RSVP to cancel check-in.

optionsCancelRsvpGuestsCheckInOptions
Returns
Return Type:Promise<CancelRsvpGuestsCheckInResponse>
JavaScript
import { rsvpV2 } from "@wix/events";

async function cancelRsvpGuestsCheckIn(rsvpId, options) {
  const response = await rsvpV2.cancelRsvpGuestsCheckIn(rsvpId, options);
}
Errors
400Invalid Argument

There is 1 error with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?