Skip to main content
PATCH
/
v1
/
permission-groups
/
{id}
Update a Permission Group
curl --request PATCH \
  --url https://sandbox-api.borderless.xyz/v1/permission-groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Operation Team",
  "description": "<string>",
  "dashboardPermissions": [
    "OrganizationApiKeysGenerate"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "dashboardPermissions": [
    "OrganizationApiKeysGenerate"
  ],
  "description": "<string>",
  "dashboardUsers": [
    {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "businessTitle": "<string>",
      "role": "OWNER",
      "deleted": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "mfaEnabled": true,
      "dashboardPermissions": [
        "OrganizationApiKeysGenerate"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
name
string

The name of the permission group

Required string length: 3 - 100
Example:

"Operation Team"

​
description
string
Required string length: 3 - 255
​
dashboardPermissions
enum<string>[]

List of permissions assigned to this group

Minimum array length: 1
Available options:
OrganizationApiKeysGenerate,
OrganizationApiKeysRegenerate,
OrganizationMfaEnable,
PermissionGroupCreate,
PermissionGroupUpdate,
PermissionGroupDelete,
PermissionGroupUserAdd,
PermissionGroupUserDelete,
UserCreate,
UserUpdate,
UserDelete,
UserChangeRole,
UserMfaEnable,
AccountCreate,
AccountAssetAddressAdd,
IdentityCreate,
IdentityUpdate,
IdentityDelete,
IdentityDocumentsUpload,
ComplianceCheckTosLinkManage,
ComplianceCheckStart,
PaymentInstructionCreate,
PaymentInstructionDelete,
TransactionAllCreate,
TransactionAllCancel,
TransactionAllExport,
WebhookPublicKeysGenerate,
WebhookCreate,
WebhookUpdate,
WebhookDelete

Response

Permission Group has been successfully updated.

​
id
string
required
​
name
string
required
​
dashboardPermissions
enum<string>[]
required
Available options:
OrganizationApiKeysGenerate,
OrganizationApiKeysRegenerate,
OrganizationMfaEnable,
PermissionGroupCreate,
PermissionGroupUpdate,
PermissionGroupDelete,
PermissionGroupUserAdd,
PermissionGroupUserDelete,
UserCreate,
UserUpdate,
UserDelete,
UserChangeRole,
UserMfaEnable,
AccountCreate,
AccountAssetAddressAdd,
IdentityCreate,
IdentityUpdate,
IdentityDelete,
IdentityDocumentsUpload,
ComplianceCheckTosLinkManage,
ComplianceCheckStart,
PaymentInstructionCreate,
PaymentInstructionDelete,
TransactionAllCreate,
TransactionAllCancel,
TransactionAllExport,
WebhookPublicKeysGenerate,
WebhookCreate,
WebhookUpdate,
WebhookDelete
​
description
string | null
​
dashboardUsers
object[]