Skip to main content

Modify User Basic Information

POST 
/auth/v1/user/basic/edit

API Description​

Modify user basic information, supports modifying nickname, username, phone number, email, avatar, gender, description and other basic information

Input Requirements:​

  • Authorization: Current logged-in user's access_token (required, passed in request header, format Bearer xxx)
  • client_id: Client ID corresponding to the application (optional, defaults to environment ID)
  • x-device-id: Device ID (optional, current logged-in device ID)
  • Request body parameters:
    • user_id: User ID (optional, requires administrator privileges when modifying other users' information)
    • nickname: Nickname (optional, 2-48 characters)
    • username: Username (optional, 2-48 characters, supports English uppercase and lowercase, numbers, special characters)
    • phone: Phone number (optional, format: +86 13000000000)
    • description: Description (optional, user personal introduction)
    • avatar_url: Avatar URL (optional)
    • gender: Gender (optional, MALE-Male, FEMALE-Female)
    • email: Email (optional, valid email format)

Prerequisites:​

  • Need valid access_token
  • Can only modify own information unless have administrator privileges
  • Username modification requires uniqueness verification
  • Phone number and email modification may require verification code verification

Output:​

  • Returns empty object indicating successful modification
  • Returns error information on error

Modify User Information Request Example​

POST /auth/v1/user/basic/edit
Authorization: Bearer your_access_token
x-device-id: device_123456
Content-Type: application/json

{
  "nickname": "Zhang San",
  "username": "zhangsan",
  "phone": "+86 13000000000",
  "description": "A developer who loves technology",
  "avatar_url": "https://example/avatar.jpg",
  "gender": "MALE",
  "email": "zhangsan@example"
}

Modify User Information Response Example (Success)​

{}

Modify User Information Response Example (Failure)​

{
  "error": "username_already_exists",
  "error_code": 409,
  "error_description": "Username already exists"
}

Usage Scenarios:​

  • User modifies personal profile
  • Administrator modifies user information
  • User binds or changes phone number, email
  • Update user avatar and basic information

Notes:​

  • Username modification requires uniqueness verification
  • Phone number and email modification require sending verification code
  • Sensitive information modification may require secondary verification
  • Administrator can modify other users' information, regular users can only modify their own information

Request​

Responses​

A successful response.

Response Headers