Update a KIO user role

QA Environment

https://qa-api.kiolinkapp.com

PATCH

/v1/roles/{id}

Roles

Last modified:2026-10-05 20:17:04

Maintainer:Not configured

Required Permission(s):users-roles-update

Updates a KIO user role's name, slug and permissions. The change is recorded in the permissions audit log.

name is required on every update.

The slug is regenerated: from slug when sent, otherwise from name.

permissions replaces the role's whole permission list; send every permission the role should keep.

An ID that does not exist results in HTTP 500.

Requires a session token whose role has the users-roles-update permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Path Params

Body Params application/jsonRequired

Example

{
  "name": "Suscriptor",
  "permissions": [
    "65f1c2a9e4b0a1b2c3d4e5f9",
    "65f1c2a9e4b0a1b2c3d4e5fa"
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://qa-api.kiolinkapp.com/v1/roles/5adeafca1f301d287fa619a6' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Suscriptor",
  "permissions": [
    "65f1c2a9e4b0a1b2c3d4e5f9",
    "65f1c2a9e4b0a1b2c3d4e5fa"
  ]
}'

Responses

🟢200The updated role

application/json

The updated role.

Bodyapplication/json

Example

{
    "_id": "5adeafca1f301d287fa619a6",
    "name": "Suscriptor",
    "slug": "suscriptor",
    "permissions": [
        "65f1c2a9e4b0a1b2c3d4e5f9",
        "65f1c2a9e4b0a1b2c3d4e5fa"
    ],
    "__v": 0
}

🟠400`name` is missing

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error (e

Modified at 2026-10-05 20:17:04

Get a KIO user role

Delete a KIO user role