Update Role - SnackBase

PUT

api

roles

{role_id}

Update Role

curl --request PUT \
  --url https://api.example.com/api/v1/roles/{role_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

{
  "id": 123,
  "name": "<string>",
  "description": "<string>"
}

Path Parameters

role_id

integer

required

Body

application/json

Request schema for updating a role.

Attributes: name: Role name. description: Optional description of the role's purpose.

name

string

required

description

string | null

Response

Successful Response

Response schema for a role.

Attributes: id: Role ID. name: Role name. description: Role description.

integer

required

name

string

required

description

string | null

Delete RoleDelete a role. Deletes the role. Default roles (admin, user) cannot be deleted. Only superadmins can delete roles. Args: role_id: Role ID. current_user: Authenticated superadmin user. session: Database session.

Update Role

curl --request PUT \
  --url https://api.example.com/api/v1/roles/{role_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'

{
  "id": 123,
  "name": "<string>",
  "description": "<string>"
}