Remove bridge login

$client->bridges->logins->remove(string loginID, string bridgeID, Scope scope): 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

bridgeID: string

Bridge ID.

loginID: string

Bridge login ID.

scope: Scope

Where this bridge login should be removed.

ReturnsExpand Collapse

LoginRemoveResponse

string bridgeID

string loginID

Scope scope

Where this bridge login should be removed.

"removed" status

?list<string> affectedAccountIDs

Remove bridge login

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(accessToken: 'My Access Token');

$login = $client->bridges->logins->remove(
  'ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc',
  bridgeID: 'local-whatsapp',
  scope: 'current-device',
);

var_dump($login);

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

Returns Examples

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