Tham chiếu API
GroupsPOST

Đặt chế độ duyệt vào nhóm

Bật hoặc tắt duyệt thành viên cho nhóm. enabled là boolean bắt buộc — khi bật, thành viên mới phải được duyệt trước khi vào.

https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-approval-mode

Tiêu đề

X-Api-Key
stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Content-Type
stringbắt buộc

Dùng application/json khi gửi nội dung yêu cầu JSON.

Tham số đường dẫn

account_id
stringbắt buộc

Định danh dùng cho route groups.

Nội dung yêu cầu

group_id
stringbắt buộc

Định danh nhóm đích.

enabled
booleanbắt buộc

Có yêu cầu quản trị viên phê duyệt thành viên mới hay không.

Nội dung phản hồi

ok
boolean

Luôn là true khi thao tác thành công; thất bại sẽ trả về mã trạng thái không thuộc 2xx.

Phản hồi

200
200 OK

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

400
Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

401
Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

404
Not Found

Không tìm thấy tài nguyên provider được yêu cầu.

409
Conflict

Thao tác đang yêu cầu xung đột với tài khoản hoặc tài nguyên nhà cung cấp đã có.

500
Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

501
Not Implemented

Provider đã chọn chưa triển khai thao tác này.

502
Bad Gateway

Adapter hoặc upstream provider không thể hoàn tất thao tác.

Yêu cầu

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-approval-mode \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "group_id": "group_example",
  "enabled": true
}'

Phản hồi

{
  "data": {
    "ok": true
  }
}