updateWaitingParticipant()

updateWaitingParticipant(id, updates) The id must correspond to a participant in waitingParticipants() — passing an unknown ID results in an error. Once access is granted, the participant is removed from waitingParticipants() and a waiting-participant-removed event fires.

Parameters

string

required

The session ID of the waiting participant.

updates

DailyWaitingParticipantUpdateOptions

required

Hide properties

grantRequestedAccess

boolean

Pass true to grant the participant access to join. Pass false to deny it.

Return value

Returns Promise<{ id: string }> — resolves with the ID of the updated participant.

Example

// Grant access to a specific waiting participant
await call.updateWaitingParticipant('session-id', {
  grantRequestedAccess: true,
});

// Deny access
await call.updateWaitingParticipant('session-id', {
  grantRequestedAccess: false,
});