setAttendance( )


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

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

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>
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?