Remove bridge login

client.bridges.logins.remove(, , ?): LoginRemoveResponse { bridgeID, loginID, scope, 2 more }

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

loginID: string

Bridge login ID.

minLength1

params: LoginRemoveParams { bridgeID, scope }

bridgeID: string

Path param: Bridge ID.

minLength1

scope: "current-device" | "all-devices"

Body param: Where this bridge login should be removed.

One of the following:

"current-device"

"all-devices"

ReturnsExpand Collapse

LoginRemoveResponse { bridgeID, loginID, scope, 2 more }

bridgeID: string

loginID: string

scope: "current-device" | "all-devices"

Where this bridge login should be removed.

One of the following:

"current-device"

"all-devices"

status: "removed"

affectedAccountIDs?: Array<string>

Remove bridge login

import BeeperDesktop from '@beeper/desktop-api';

const client = new BeeperDesktop({
  accessToken: process.env['BEEPER_ACCESS_TOKEN'], // This is the default and can be omitted
});

const login = await client.bridges.logins.remove('ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc', {
  bridgeID: 'local-whatsapp',
  scope: 'current-device',
});

console.log(login.bridgeID);

{
  "bridgeID": "bridgeID",
  "loginID": "loginID",
  "scope": "current-device",
  "status": "removed",
  "affectedAccountIDs": [
    "string"
  ]
}

Returns Examples

{
  "bridgeID": "bridgeID",
  "loginID": "loginID",
  "scope": "current-device",
  "status": "removed",
  "affectedAccountIDs": [
    "string"
  ]
}