Update

PATCH

/api/v1/users/{id}

Updates a user. Send only the fields you want to change — anything you omit is left exactly as it was, including roles.

Supply password only when you intend to reset it. Omit it and the existing password is preserved.

Supplying roleIds replaces the user's roles rather than adding to them. Read the current roles with Detail first if you mean to append.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠401Unauthorized

🟠429Too Many Requests

🟠404Not Found

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://apigw.klinkcx.com/api/v1/users/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "email": "string",
    "password": "string",
    "roleIds": [
        "string"
    ],
    "phone": "string",
    "address": "string",
    "globalAgentCapacity": 0
}'

Response Example

200 - Example 1

{
    "requestId": "string",
    "data": {
        "id": "string",
        "name": "string",
        "email": "string",
        "phone": "string",
        "address": "string",
        "globalAgentCapacity": 0,
        "roles": [
            {
                "id": "string",
                "systemName": "string",
                "displayName": "string",
                "description": "string"
            }
        ],
        "createdAt": "string",
        "updatedAt": "string"
    }
}

Modified at 2026-08-10 03:17:25

Detail

Delete