Skip to content
Download Beeper

Remove bridge login

bridges.logins.remove(strlogin_id, LoginRemoveParams**kwargs) -> LoginRemoveResponse
POST/v1/bridges/{bridgeID}/logins/{loginID}/remove

Remove a bridge login from this device or, when supported by the bridge, from all devices.

ParametersExpand Collapse
bridge_id: str

Bridge ID.

minLength1
login_id: str

Bridge login ID.

minLength1
scope: Literal["current-device", "all-devices"]

Where this bridge login should be removed.

One of the following:
"current-device"
"all-devices"
ReturnsExpand Collapse
class LoginRemoveResponse:
bridge_id: str
login_id: str
scope: Literal["current-device", "all-devices"]

Where this bridge login should be removed.

One of the following:
"current-device"
"all-devices"
status: Literal["removed"]
affected_account_ids: Optional[List[str]]

Remove bridge login

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
)
login = client.bridges.logins.remove(
    login_id="ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
    bridge_id="local-whatsapp",
    scope="current-device",
)
print(login.bridge_id)
{
  "bridgeID": "bridgeID",
  "loginID": "loginID",
  "scope": "current-device",
  "status": "removed",
  "affectedAccountIDs": [
    "string"
  ]
}
Returns Examples
{
  "bridgeID": "bridgeID",
  "loginID": "loginID",
  "scope": "current-device",
  "status": "removed",
  "affectedAccountIDs": [
    "string"
  ]
}