PATCH Item (update)

Developing

PATCH

/api/roles/{role}

Partially update a role's name, description, permissions, and default status. Same handler as PUT — all fields are accepted. Default system roles cannot have their name changed.

Permission: view roles (route middleware) + Policy update

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api-dev.commandroom.ai/api/api/roles/1' \
--header 'Authorization: Bearer {{token}}' \
--header 'X-Tenant-UUID: ' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Sample Name",
  "description": "Sample description text.",
  "permissions": [
    1
  ],
  "is_default": true
}'

Response Example

200 - OK

{
  "message": "Success.",
  "data": {
    "id": 1,
    "name": "Sample Name",
    "description": "Sample description text.",
    "guard_name": "Sample Guard Name",
    "is_default": true,
    "organization_id": 1,
    "permissions": [
      {
        "id": 1,
        "name": "Sample Name"
      }
    ],
    "users": [
      {
        "id": 1,
        "name": "Sample Name",
        "email": "user@example.com"
      }
    ],
    "created_at": "2026-01-15T10:30:00.000000Z",
    "updated_at": "2026-01-15T10:30:00.000000Z"
  }
}

Modified at 2026-07-02 04:47:16

PUT Item (update)

DELETE Item (destroy)