OMomni
Branches

Open or close a branch to viewers

Changed on
<Note> Opening a branch with this endpoint requires permission to edit every model in the branch.

Closing a branch only requires permission to edit the branch on one of its member models. </Note>

Open a branch to Viewers and Restricted Queriers - including embed users - so they see the branch's content instead of production, or close it again. See Opening a branch to viewers for more information.

patch/v1/branches/{branchId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/branches/{branchId}
  • Auth
    HTTP bearer

Path parameters

branch_idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174001

The organization-wide branch ID (orgBranchId). This isn't the same as the ID of a branch model.

Query parameters

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Request body

openToViewersboolean required

true to open the branch to Viewers and Restricted Queriers, false to close it.

Response

The branch was opened or closed successfully.

successboolean

Whether the operation succeeded.

Changes