setAttendance( )
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Sets information about whether a booking's session was attended. This information
is saved in an Attendance
object.
If attendance was already set, meaning the Attendance
object already exists, the
existing attendance information is updated. Otherwise, a new Attendance
object
is created.
By default, the number
of attendees is set to 1
, but you can set a number to greater than 1
if multiple
participants attended. Do not set to 0
to indicate that no one attended the session.
Instead, set the status
field to NOT_ATTENDED
.
Note: Make sure your code validates that:
- There is no mismatch between
numberOfAttendees
andattendanceStatus
to make sure, for example, thatattendanceStatus
is notNOT_ATTENDED
whilenumberOfAttendees
is5
. - The attendance's
numberOfAttendees
and the booking'snumberOfParticipants
correspond. For example, the number of attendees usually should not exceed the booking's intended number of participants (unless perhaps you allow walk-ins that did not sign up in advance).
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Permission Scopes
For app development, you must have one of the following permission scopes:
The attendance information for a booked session that you want to create or update.