Activate or deactivate a KIO user

QA Environment

https://qa-api.kiolinkapp.com

PATCH

/v1/users/{id}/status

Users

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

Maintainer:Not configured

Required Permission(s):users-users-update

Sets whether a KIO user is active. Inactive users cannot sign in.

A valid ID that does not exist returns HTTP 200 with an empty body.

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

Request

Authorization

API Key

Add parameter in header

authorization

Example:

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

Path Params

Body Params application/jsonRequired

Example

{
  "status": false
}

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/users/65f1c2a9e4b0a1b2c3d4e5e7/status' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "status": false
}'

Responses

🟢200The user's ID and new status, or an empty body if the user d

application/json

The user's ID and new status, or an empty body if the user does not exist.

Bodyapplication/json

Example

{
    "_id": "65f1c2a9e4b0a1b2c3d4e5e7",
    "status": false
}

🟠400`status` is not a boolean, or `id` is not a valid ObjectId

🟠401The session token expired

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

🔴500Unexpected error

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

Update a KIO user

Delete a KIO user