Remove bridge login

client.Bridges.Logins.Remove(ctx, loginID, params) (*BridgeLoginRemoveResponse, error)

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 BridgeLoginRemoveParams

BridgeID param.Field[string]

Path param: Bridge ID.

minLength1

Scope param.Field[BridgeLoginRemoveParamsScope]

Body param: Where this bridge login should be removed.

const BridgeLoginRemoveParamsScopeCurrentDevice BridgeLoginRemoveParamsScope = "current-device"

const BridgeLoginRemoveParamsScopeAllDevices BridgeLoginRemoveParamsScope = "all-devices"

ReturnsExpand Collapse

type BridgeLoginRemoveResponse struct{…}

BridgeID string

LoginID string

Scope BridgeLoginRemoveResponseScope

Where this bridge login should be removed.

One of the following:

const BridgeLoginRemoveResponseScopeCurrentDevice BridgeLoginRemoveResponseScope = "current-device"

const BridgeLoginRemoveResponseScopeAllDevices BridgeLoginRemoveResponseScope = "all-devices"

Status Removed

AffectedAccountIDs []stringOptional

Remove bridge login

package main

import (
  "context"
  "fmt"

  "github.com/beeper/desktop-api-go"
  "github.com/beeper/desktop-api-go/option"
)

func main() {
  client := beeperdesktopapi.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  login, err := client.Bridges.Logins.Remove(
    context.TODO(),
    "ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
    beeperdesktopapi.BridgeLoginRemoveParams{
      BridgeID: "local-whatsapp",
      Scope: beeperdesktopapi.BridgeLoginRemoveParamsScopeCurrentDevice,
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
  ]
}