Vô hiệu hoá người dùng
API hỗ trợ vô hiệu hoá người dùng theo user_id
HTTP request
POST https://{app_id}.api.piscale.com/user/v1.0/user/{user_id}/deactivate
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 vô hiệu hoá 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ụ
{
"is_leave_all_thread": true
}
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
is_leave_all_thread | boolean | Có rời khỏi tất cả các cuộc hội thoại nhóm mà người dùng đã tham gia 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 |