kintone API ドキュメント

ゲストスペースのゲストメンバーを更新する

目次

ゲストスペースのゲストメンバーを更新する

ゲストスペースのゲストメンバーを更新します。

  • スペース機能を利用していない場合やゲストスペース機能が無効の場合には、エラーが発生します。
  • この API を実行する前に、 ゲストユーザーを追加する API で、ゲストユーザーを追加してください。

URL

https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/space/guests.json

HTTP メソッド

PUT

必要なアクセス権

  • スペース管理者

リクエスト

パラメーター
パラメーター名 型 必須 説明
id 数値または文字列 必須 ゲストメンバーを更新するゲストスペースのスペース ID
guests 配列（文字列） 必須 所属するゲストメンバーのログイン名（メールアドレス）の配列
kintone のゲストユーザではないユーザー／使用停止中のユーザー／削除したユーザーを指定すると、エラーが発生します。
リクエストの例
ヘッダー
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

{}

サンプルコード

curl を使ったリクエスト
 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"
    ]
  }'
kintone REST API リクエストを送信する 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);