Skip to content
On this page

User Rename

🔑 Need JWT Authorization

Description

Update user name

Method And Path

js
POST /v2/user/rename

Request

ts
{
    "authorization": string;
    "x-request-id": string;
    "x-session-id": string;
}

Body

ts
{
    "newUserName": string;
}

newUserName

New user name

  • minLength: 1
  • maxLength: 50

Response

Success

HTTP Status Code: 200

ts
{
    status: Status.Success,
    data: {}
}

Extends Type: Status

Failed

HTTP Status Code: 200

ts
{
    status: Status.Failed,
    code: ErrorCode
}

Extends Type: Status, ErrorCode

Released under the MIT License.