kintone API

刪除訪客

刪除kintone訪客。

目錄

HTTP 方法DELETE
URLhttps://sample.cybozu.com/k/v1/guests.json
認證 密碼驗證 , 會話認證
Content-Typeapplication/json

請求參數

參數名稱 類型 必須 說明
guests 陣列(字串) 必須 要刪除的來賓用戶的電子郵件地址清單
您最多可以指定 100 個電子郵件位址。

回應屬性

所需存取權限

  • kintone的系統管理員

範例

1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規格

1
2
3
{
  "guests": ["guest1@example.com", "guest2@example.com", "guest3@example.com"]
}

1
{}

有關kintone.api()的說明,請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5
6
7
8
9
const body = {
  guests: [
    'guest1@example.com',
    'guest2@example.com',
    'guest3@example.com',
  ]
};

await kintone.api(kintone.api.url('/k/v1/guests.json', true), 'DELETE', body);

根據您的環境,curl的格式可能會有所不同。
有關說明,請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl -X DELETE 'https://sample.cybozu.com/k/v1/guests.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "guests": [
      "guest1@example.com",
      "guest2@example.com",
      "guest3@example.com"
    ]
  }'

補充

  • 即使禁用了空間功能或訪客空間功能,也可以執行。
  • 訪客的資訊將從kintone中刪除,而不是從訪客空間中取消訂閱。
    如果您想退出訪客空間,請使用更新訪客空間的訪客API,以更新訪客空間的訪客。
    更新訪客空間的訪客API