Skip to content
Download Beeper

Cancel bridge login session

bridges.login_sessions.cancel(strlogin_session_id, LoginSessionCancelParams**kwargs) -> LoginSessionCancelResponse
DELETE/v1/bridges/{bridgeID}/login-sessions/{loginSessionID}

Cancel a temporary bridge login session.

ParametersExpand Collapse
bridge_id: str

Bridge ID.

minLength1
login_session_id: str

Temporary bridge login session ID.

minLength1
ReturnsExpand Collapse
class LoginSessionCancelResponse:
bridge_id: str
login_session_id: str
status: Literal["cancelled"]

Cancel bridge login session

import os
from beeper_desktop_api import BeeperDesktop

client = BeeperDesktop(
    access_token=os.environ.get("BEEPER_ACCESS_TOKEN"),  # This is the default and can be omitted
)
response = client.bridges.login_sessions.cancel(
    login_session_id="123",
    bridge_id="local-whatsapp",
)
print(response.bridge_id)
{
  "bridgeID": "bridgeID",
  "loginSessionID": "loginSessionID",
  "status": "cancelled"
}
Returns Examples
{
  "bridgeID": "bridgeID",
  "loginSessionID": "loginSessionID",
  "status": "cancelled"
}