kintone API

更新訪客空間的訪客

更新訪客空間的訪客。

目錄

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

請求參數

參數名稱 類型 必須 說明
id 數值或字串 必須 要更新訪客成員的訪客空間的空間ID
guests 陣列(字串) 必須 訪客成員所屬的登入名(電子郵件地址)陣列
如果指定的使用者不是kintone的Guest使用者、暫停使用者或已刪除的使用者,則會發生錯誤。

應答屬性

所需存取權限

  • 空間管理員

範例

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

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

1
2
3
4
{
  "id": "1",
  "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
10
const body = {
  id: 1,
  guests: [
    'guest1@example.com',
    'guest2@example.com',
    'guest3@example.com',
  ]
};

await kintone.api(kintone.api.url('/k/guest/1/v1/space/guests.json', false), 'PUT', body);

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

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

補充

  • 如果不使用空間功能或禁用訪客空間功能,則會發生錯誤。
  • 在運行此 API 之前,請在要新增訪客的 API 中新增訪客。
    新增訪客 API