Cập nhật thông tin người dùng

API hỗ trợ cập nhật thông tin người dùng theo user_id.

HTTP request

PATCH https://{app_id}.api.piscale.com/user/v1.0/user/{user_id}

Request header

Bảng mô tả tham số của request header:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
X-Api-Key	string	API Key của ứng dụng	✓
X-Tenant-Id	string	Chỉ định cập nhật thông tin user của tenant nào (ID bên hệ thống của bạn)	✗

Parameters

Bảng mô tả tham số:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
user_id	string	Chỉ định ID duy nhất của user (ID bên hệ thống của bạn)	✓

Request body

Content-Type: application/json

Ví dụ

{
    "display_name": "Emily Johnson",
    "alias": "emily_johnson92",
    "avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290962.png",
    "user_type_id": 1,
    "verified": true
}

Bảng mô tả thuộc tính:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
display_name	string	Tên hiển thị. Max 80 kí tự	✗
alias	string	Tên khác. Max 80 kí tự	✗
avatar_url	string	Đường dẫn dùng để hiển thị avatar. Max 2048 kí tự	✗
user_type_id	number	Danh sách User Type ID của user, nếu không cung cấp sẽ không cập nhật User Type, mặc định type Default	✗
verified	bool	User được xác thực hay không	✗

Responses

Nếu thành công, API này trả về dữ liệu như sau:

Status: 200 OK

{
  "message_code": "M200",
  "message": "Success"
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp