Hikka Docs Hikka Docs
EndpointsAdmin

Update user

PATCH
/admin/user/{username}

Path Parameters

username*string

Header Parameters

auth?|
auth?|

Request Body

application/json

description?|
forbid_actions?array<>|

Actions to forbid user to do

forbid_actions_merge?boolean

Whether to merge or replace user's forbidden actions

Defaultfalse
remove_avatar?boolean

Whether to remove user's avatar

Defaultfalse
remove_cover?boolean

Whether to remove user's cover

Defaultfalse
remove_description?boolean

Whether to remove user's description

Defaultfalse
banned?|

Set user 'banned' status

[key: string]?never

Response Body

application/json

application/json

curl -X PATCH "https://api.hikka.io/admin/user/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "reference": "c773d0bf-1c42-4c18-aec8-1bdd8cb0a434",
  "updated": 1686088809,
  "created": 1686088809,
  "description": "Hikka",
  "username": "hikka",
  "cover": "string",
  "active": true,
  "avatar": "string",
  "role": "string"
}
{
  "message": "Example error message",
  "code": "example_error"
}