---
title: "Update a role"
method: PUT
path: "/settings/roles/{id}"
tags: ["Admin Settings: Roles"]
---

# Update a role

`PUT /settings/roles/{id}`

## Request

- Base URL: `http://localhost:8000/api/admin`
- URL: `http://localhost:8000/api/admin/settings/roles/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-admin-api/docs/settings/roles/:id/put.ts> (a function with typed inputs; its response is checked against the schema)

Update a role

## Path parameters

- `id` integer, required

## Request body

- object
  - `name` string, required
  - `description` string, required
  - `permission_type` 'all' | 'custom', required
  - `permissions` string[]

## Response `200`

Role updated.

- AdminSettingsRole: Admin Settings → Roles endpoints (Block B Wave 2). REST: GET /api/admin/settings/roles GET /api/admin/settings/roles/{id} POST /api/admin/settings/roles PUT /api/admin/settings/roles/{id} DELETE /api/admin/settings/roles/{id} (guards: in-use, last-role) GraphQL: adminSettingsRoles / adminSettingsRole createAdminSettingsRole / updateAdminSettingsRole / deleteAdminSettingsRole Mirrors Webkul\Admin\Http\Controllers\Settings\RoleController 1:1.
  - `id` integer, nullable
  - `name` string, nullable
  - `description` string, nullable
  - `permissionType` string, nullable
  - `permissions` string[], nullable
  - `createdAt` string, nullable
  - `updatedAt` string, nullable
  - `message` string, nullable

## Other responses

- `400`: Invalid input
- `404`: Role not found.
- `422`: Validation failure.

---

[API](https://skmtc.dev/bagisto/apis/bagisto-admin-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-admin-api/revisions/3198f11be70f?raw)