setAttendance( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sets or updates attendance information for a booking session. This information is stored in an attendance object.

If an attendance object already exists for the session, it's updated. Otherwise, a new object is created.

By default, numberOfAttendees is set to 1, but you can specify a higher number if multiple participants attended. Do not set numberOfAttendees to 0 to indicate no attendance, instead specify {"status": "NOT_ATTENDED"}.

Validation guidelines:

  • The call succeeds for mismatches between numberOfAttendees and status. For example, make sure that your code doesn't specify {"status": "NOT_ATTENDED"} with {"numberOfAttendees": 5}.
  • The API also allows numberOfAttendees to exceed the booking's numberOfParticipants. Use higher values only when scenarios like walk-ins justify the exception.
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 Bookings - all permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
attendanceAttendanceRequired

Attendance to create or update.

optionsSetAttendanceOptions

Options to use when setting an attendance.

Returns
Return Type:Promise<SetAttendanceResponse>
JavaScript
Errors
400Invalid Argument

There is 1 error with this status code.

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

Did this help?