Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Bridge Management

Update Bridge

Updates a bridge by bridgeId identifier. The request body should contain JSON object with updating properties. Update can only be done by bridge owner, his delegate or any user who has the Super Admin privilege.

patch/rcvideo/v2/bridges/{bridgeId}

Path parameters

bridgeIdstring required

Bridge identifier

Request body

namestring

Custom name of a bridge

Example request

{
  "name": "Weekly Meeting with Joseph",
  "pins": {
    "web": "018209241352"
  },
  "security": {
    "passwordProtected": true,
    "password": "Wq123ygs15"
  },
  "preferences": {
    "join": {
      "waitingRoomRequired": "Nobody"
    },
    "joinBeforeHost": true,
    "recordingsMode": "User",
    "transcriptionsMode": "User",
    "recordings": {
      "everyoneCanControl": {
        "enabled": true
      },
      "autoShared": {
        "enabled": true
      }
    }
  }
}

Response

OK

idstring

Unique bridge identifier

namestring

Custom name of a bridge

type'Instant' | 'Scheduled' | 'PMI'

Type of bridge. It specifies bridge life cycle.

  1. Instant - The bridge will be used for a meeting only once immediately after creation. Then it will be deleted.
  2. Scheduled - The bridge will be used for scheduled one or more meetings. If the bridge is not used for a long time after the last meeting, then it will be deleted.
  3. PMI - The bridge will contain Personal Meeting Identifier owned by a user. It is the default user bridge. Each user may have only one default (PMI) bridge. Such bridge will be deleted only in case the user is deleted from the system.

Example response

{
  "id": "iad41-c04-ndb256065cf14ae6a1832389d9c2e",
  "name": "Weekly Meeting with Joseph",
  "type": "Instant",
  "host": {
    "accountId": "664287016",
    "extensionId": "664307016"
  },
  "pins": {
    "pstn": {
      "host": "432331057631",
      "participant": "013409241367"
    },
    "web": "018209241352",
    "aliases": [
      "joseph1990",
      "qa_team_2_lead"
    ]
  },
  "security": {
    "password": {
      "plainText": "Wq123ygs15",
      "pstn": "7492486829",
      "joinQuery": "99e4f8e6a241fc71279449a9c8f46eef"
    }
  },
  "preferences": {
    "join": {
      "waitingRoomRequired": "Nobody"
    },
    "joinBeforeHost": true,
    "recordingsMode": "User",
    "transcriptionsMode": "User",
    "recordings": {
      "everyoneCanControl": {
        "enabled": true
      },
      "autoShared": {
        "enabled": true
      }
    }
  },
  "discovery": {
    "web": "https://v.ringcentral.com/join/018209241352?pw=99e4f8e6a241fc71279449a9c8f46eef"
  }
}