Skip to main content
POST
/
update_brx_acl
Update BRK ACL
curl --request POST \
  --url https://api.example.com/update_brx_acl \
  --header 'Content-Type: application/json' \
  --data '
{
  "brxId": "<string>",
  "isPublic": true,
  "isClone": true,
  "emails": [
    {
      "email": "<string>",
      "permission": 123
    }
  ]
}
'
{
  "400": {},
  "401": {},
  "403": {},
  "404": {},
  "500": {},
  "httpResponse": {
    "isError": true,
    "statusMsg": "<string>"
  }
}
This endpoint updates the access control list (ACL) for a BRK. It allows you to change the visibility of a BRK (public or private), control whether it can be cloned, and manage user permissions. Only the owner of a BRK or users with editor permissions can update the ACL.

​
Request

​
brxId
string
required
The ID of the BRK to update ACL for
​
isPublic
boolean
Whether the BRK is public (visible to all users) or private (visible only to specified users)
​
isClone
boolean
Whether the BRK can be cloned by other users
​
emails
array
required
Array of user email addresses and their permission levels

​
Example Request (Make Private)

{
  "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef",
  "isPublic": false,
  "isClone": true,
  "emails": [
    {
      "email": "[email protected]",
      "permission": 2
    },
    {
      "email": "[email protected]",
      "permission": 1
    },
    {
      "email": "[email protected]",
      "permission": 0
    }
  ]
}

​
Example Request (Make Public)

{
  "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef",
  "isPublic": true,
  "isClone": true,
  "emails": [
    {
      "email": "[email protected]",
      "permission": 2
    }
  ]
}

​
Response

​
httpResponse
object

​
Example Response

{
  "httpResponse": {
    "isError": false,
    "statusMsg": "Successfully updated BRK ACL"
  }
}

​
Error Codes

​
400
object
Bad Request - The request was malformed or missing required parameters
​
401
object
Unauthorized - Authentication credentials are missing or invalid
​
403
object
Forbidden - The authenticated user does not have permission to update the ACL for the requested BRK
​
404
object
Not Found - The requested BRK does not exist
​
500
object
Internal Server Error - An unexpected error occurred on the server

​
Notes

  • Only the owner of a BRK or users with editor permissions can update the ACL.
  • When making a BRK public (isPublic: true), it will be visible to all users, but only users with explicit permissions can edit or delete it.
  • When making a BRK private (isPublic: false), it will only be visible to users specified in the emails array.
  • The isClone parameter controls whether other users can clone the BRK. Cloning creates a copy of the BRK that the user owns and can modify.
  • The emails array must include at least one user with owner permissions (permission level 2).
  • Permission levels:
    • 0: Viewer (can view and execute the BRK)
    • 1: Editor (can view, execute, and edit the BRK)
    • 2: Owner (can view, execute, edit, and delete the BRK, as well as manage permissions)
  • To check the current ACL for a BRK, use the Check BRK ACL endpoint.