← API リファレンス
GroupsPOST

参加リクエストの承認 / 拒否

保留中の参加リクエストを一括で承認または拒否します。action は approve か reject、member_ids には参加リクエスト一覧で返る id を 1 つ以上指定します。

https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests/update

ヘッダー

X-Api-Key
string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

Content-Type
string必須

JSON のリクエストボディを送る場合は application/json を使用します。

パスパラメータ

account_id
string必須

groups ルートで使用される識別子。

リクエストボディ

group_id
string必須

対象グループ識別子。

action
string必須

プロバイダが対応するメンバーまたは承認操作。

enum: approve, reject

member_ids[]
string[]必須

処理する参加リクエストのメンバー識別子。

minItems: 1

レスポンスボディ

ok
boolean

操作が成功したときは常に true。失敗時は代わりに 2xx 以外のステータスが返ります。

レスポンス

200
200 OK

リクエスト成功。レスポンスボディの例を参照してください。

400
Bad Request

リクエストボディ、パス、またはパラメータが不正です。

401
Unauthorized

X-Api-Key ヘッダが欠落しているか無効です。

404
Not Found

要求されたプロバイダリソースが見つかりません。

409
Conflict

要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。

500
Internal Server Error

サービスで予期しないエラーが発生しました。

501
Not Implemented

選択したプロバイダはこの操作を実装していません。

502
Bad Gateway

プロバイダアダプタまたは上流サービスが操作を完了できませんでした。

リクエスト

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests/update \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "group_id": "group_example",
  "action": "approve",
  "member_ids": ["member_example", "member_other"]
}'

レスポンス

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