BAbagisto
Admin Settings: Roles

Update a role

Update a role

put/settings/roles/{id}

Request

Path parameters

idinteger required
Example:2

Role ID.

Request body

namestring required
descriptionstring required
permission_type'all' | 'custom' required
permissionsstring[]

Example request

{
  "name": "Catalog Manager",
  "description": "Updated description",
  "permission_type": "custom",
  "permissions": [
    "catalog.products"
  ]
}

Response

Role updated.

idinteger nullable
namestring nullable
descriptionstring nullable
permissionTypestring nullable
permissionsstring[] nullable
createdAtstring nullable
updatedAtstring nullable
messagestring nullable

Example response

{
  "id": 1,
  "name": "Administrator",
  "description": "Full access to all modules",
  "permissionType": "all",
  "permissions": [
    "catalog.products.create",
    "sales.orders.view"
  ],
  "createdAt": "2026-05-25T08:15:00+00:00",
  "updatedAt": "2026-05-25T08:20:00+00:00",
  "message": "Role deleted successfully."
}

Changes

No recorded changes to this operation across all 8 revisions of this API.