Herald
OpenapiUsers

Update a user

Update user status or nickname. Email is read-only after creation. Requires `users.manage` permission.

PUT
/api/users/{userId}

Update user status or nickname. Email is read-only after creation. Requires users.manage permission.

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Path Parameters

userId*string

User ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

nickname?string|null
status?|
Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/users/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "createdAt": "string",  "email": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "nickname": "string",  "realmId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}