---
title: "Update Bridge"
method: PATCH
path: "/rcvideo/v2/bridges/{bridgeId}"
tags: ["Bridge Management"]
---

# Update Bridge

`PATCH /rcvideo/v2/bridges/{bridgeId}`

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.

## Path parameters

- `bridgeId` string, required

## Request body

- UpdateBridgeRequest
  - `name` string — Custom name of a bridge
  - `pins` BridgePinsWithoutPstn
    - `web` string — Bridge short identifier (Web PIN). The digital unique code which is used to join to a meeting. If it is not specified while creation, then a code will be generated. If it is a default bridge, then this code is Personal Meeting Identifier (PMI). NOTE: Changing this PIN via update method is deprecated. So to change Web PIN use the method: _*[PATCH] /rcvideo/v2/bridges/{bridgeId}/pin/web*_
  - `security` BridgeRequestSecurity
    - `passwordProtected` boolean — Specifies if a meeting is password protected. By default, Instant and Scheduled bridges are not password protected. For default (PMI) bridge, password protection will be turned on and the password will be generated if it is not specified while creation. While creation to set password protection you should set this field to true and specify a password in the **password** field. If you want to change password or set password protection for an unprotected bridge, you should set this field to true and specify a password in the **password** field in the update operation. To make protected bridge as unprotected you should set this field to false in the update operation.
    - `password` string — Specifies a password if bridge meetings should be password protected (passwordProtected field is true). Besides that, if the field is specified in the request but **passwordProtected** field is missing then it means that **passwordProtected** field is set to true.
    - `noGuests` boolean — If true, only authenticated users can join to a meeting.
    - `sameAccount` boolean — If true, only users have the same account can join to a meeting.
    - `e2ee` boolean — If true, end to end encryption will be enabled for a meeting.
  - `preferences` BridgePreferences
    - `join` BridgeJoinPreferences
      - `audioMuted` boolean — Specifies if audio is muted for meeting participants (in the preset after joining)
      - `videoMuted` boolean — Specifies if video is muted for meeting participants (in the preset after joining)
      - `waitingRoomRequired` 'Nobody' | 'Everybody' | 'GuestsOnly' | 'OtherAccount' — Specifies rules for the waiting room before the host starts the meeting. 1) Nobody - No waiting room. Participants are not waiting for meeting start. 2) Everybody - All participants are waiting for meeting start. 3) GuestsOnly - Only unauthenticated participants (guests) are waiting for meeting start. 4) OtherAccount - Only participants who have other account are waiting for meeting start. Default value depends on the bridge type: - PMI -> OtherAccount - Instant, Scheduled -> Nobody
      - `pstn` BridgeJoinPstnPreferences
        - `promptAnnouncement` boolean — Specifies whether to play 'Announce yourself' prompt
        - `promptParticipants` boolean — Specifies whether to play 'There are X participants' prompt
    - `playTones` 'On' | 'Off' | 'ExitOnly' | 'EnterOnly' — Specifies enter and exit tones mode. 1) On - Enter and exit tones switched on. 2) Off - Enter and exit tones switched off. 3) ExitOnly - Only exit tones switched on. 4) EnterOnly - Only enter tones switched on.
    - `musicOnHold` boolean — Specifies whether to play music on hold when alone
    - `joinBeforeHost` boolean — Specifies if participants can join to a meeting before host. Default value depends on the bridge type: - default bridge (PMI) -> false - other types -> true
    - `screenSharing` boolean — Specifies if screen sharing is allowed
    - `recordingsMode` 'Auto' | 'ForceAuto' | 'User' — Controls whether recordings are enabled automatically or by user decision
    - `transcriptionsMode` 'Auto' | 'ForceAuto' | 'User' — Controls whether transcriptions are enabled automatically or by user decision
    - `recordings` RecordingsPreferences — Recordings preferences
      - `everyoneCanControl` EveryoneCanControl — Controls whether participants can start and pause recording
        - `enabled` boolean — Controls whether preference is enabled
        - `locked` boolean — Describes whether preference is locked on Service Web
      - `autoShared` AutoShared — Controls whether recording can be auto shared
        - `enabled` boolean — Controls whether preference is enabled
        - `locked` boolean — Describes whether preference is locked on Service Web
    - `allowEveryoneTranscribeMeetings` boolean — Controls whether participants can start and pause transcription

## Response `200`

OK

- BridgeResponse
  - `id` string — Unique bridge identifier
  - `name` string — 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.
  - `host` User
    - `accountId` string, required — User account identifier
    - `extensionId` string, required — User extension identifier
  - `pins` BridgePinsWithAliases
    - `pstn` BridgePstnPins
      - `host` string — Host PSTN PIN. If it is not specified while creation, then a PIN will be generated.
      - `participant` string — Participant PSTN PIN. If it is not specified while creation, then a PIN will be generated.
    - `web` string — Bridge short identifier (Web PIN). The digital unique code which is used to join to a meeting. If it is not specified while creation, then a code will be generated. If it is a default bridge, then this code is Personal Meeting Identifier (PMI). NOTE: Changing this PIN via update method is deprecated. So to change Web PIN use the method: _*[PATCH] /rcvideo/v2/bridges/{bridgeId}/pin/web*_
    - `aliases` string[] — List of bridge aliases. An alias is a unique personal meeting name that can be specified for the default bridge. It can be used to join to a meeting in the same way as the short identifier.
  - `security` BridgeResponseSecurity
    - `passwordProtected` boolean — Specifies if a meeting is password protected.
    - `password` BridgeResponseSecurityPassword
      - `plainText` string — Meeting password. This field will be returned only if the request was done by bridge owner, his delegate or any user who has the Super Admin privilege.
      - `pstn` string — Meeting password for PSTN users. This field will be returned only if the request was done by bridge owner, his delegate or any user who has the Super Admin privilege.
      - `joinQuery` string — Meeting password hash. This field will be returned only if the request was done by bridge owner, his delegate or any user who has the Super Admin privilege.
    - `noGuests` boolean — If true, only authenticated users can join to a meeting.
    - `sameAccount` boolean — If true, only users have the same account can join to a meeting.
    - `e2ee` boolean — If true, end to end encryption will be enabled for a meeting.
  - `preferences` BridgePreferences
    - `join` BridgeJoinPreferences
      - `audioMuted` boolean — Specifies if audio is muted for meeting participants (in the preset after joining)
      - `videoMuted` boolean — Specifies if video is muted for meeting participants (in the preset after joining)
      - `waitingRoomRequired` 'Nobody' | 'Everybody' | 'GuestsOnly' | 'OtherAccount' — Specifies rules for the waiting room before the host starts the meeting. 1) Nobody - No waiting room. Participants are not waiting for meeting start. 2) Everybody - All participants are waiting for meeting start. 3) GuestsOnly - Only unauthenticated participants (guests) are waiting for meeting start. 4) OtherAccount - Only participants who have other account are waiting for meeting start. Default value depends on the bridge type: - PMI -> OtherAccount - Instant, Scheduled -> Nobody
      - `pstn` BridgeJoinPstnPreferences
        - `promptAnnouncement` boolean — Specifies whether to play 'Announce yourself' prompt
        - `promptParticipants` boolean — Specifies whether to play 'There are X participants' prompt
    - `playTones` 'On' | 'Off' | 'ExitOnly' | 'EnterOnly' — Specifies enter and exit tones mode. 1) On - Enter and exit tones switched on. 2) Off - Enter and exit tones switched off. 3) ExitOnly - Only exit tones switched on. 4) EnterOnly - Only enter tones switched on.
    - `musicOnHold` boolean — Specifies whether to play music on hold when alone
    - `joinBeforeHost` boolean — Specifies if participants can join to a meeting before host. Default value depends on the bridge type: - default bridge (PMI) -> false - other types -> true
    - `screenSharing` boolean — Specifies if screen sharing is allowed
    - `recordingsMode` 'Auto' | 'ForceAuto' | 'User' — Controls whether recordings are enabled automatically or by user decision
    - `transcriptionsMode` 'Auto' | 'ForceAuto' | 'User' — Controls whether transcriptions are enabled automatically or by user decision
    - `recordings` RecordingsPreferences — Recordings preferences
      - `everyoneCanControl` EveryoneCanControl — Controls whether participants can start and pause recording
        - `enabled` boolean — Controls whether preference is enabled
        - `locked` boolean — Describes whether preference is locked on Service Web
      - `autoShared` AutoShared — Controls whether recording can be auto shared
        - `enabled` boolean — Controls whether preference is enabled
        - `locked` boolean — Describes whether preference is locked on Service Web
    - `allowEveryoneTranscribeMeetings` boolean — Controls whether participants can start and pause transcription
  - `discovery` BridgeDiscovery
    - `web` string — URI that can be used to join to the meeting. It contains password parameter only if the request was done by bridge owner, his delegate or any user who has the Super Admin privilege.

## Other responses

- `403` — Access denied
- `404` — Not found
- `406` — Not acceptable
- `409` — Conflicting settings
- `500` — Internal server error

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)