OMomniapp
Branches

Update branch

Changed on

Opens the branch to Viewers and Restricted Queriers of its models, or closes it. Opening requires permission to update every model in the branch; closing requires permission to edit any one of them in a branch. The flag turns off again whenever a model is added to the branch.

patch/api/v1/branches/{branchId}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/branches/{branchId}
  • Auth
    HTTP bearer

Path parameters

branchIdstring uuid required

Branch ID: the org-wide branch, as orgBranchId on branch responses. A model-level branch ID is not accepted.

Query parameters

userIdstring uuid

User ID of the user to act as, as userId on other endpoints. Required with an organization API key; a user-scoped key may only name its own user.

Request body

openToViewersboolean required

Whether users who can view a model in the branch but cannot use branches on it, Viewers and Restricted Queriers, see the branch instead of production. Turns off again whenever a model is added to the branch.

Response

Branch updated

successboolean required

Whether the operation succeeded

Changes