ゲストスペースのゲストメンバーを指定した内容で上書きして更新します。
- スペース機能を利用していない場合にはエラーになります。
- ゲストスペース機能を利用していない場合にはエラーになります。
- メンバー更新の前にゲストユーザーの一括追加 API を使用してゲストユーザーを追加しておく必要があります。
HTTP メソッド
PUT
URI
https://(サブドメイン名).cybozu.com/k/guest/<ゲストスペースのID>/v1/space/guests.json
必要なアクセス権
スペース管理者
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| id | 数値又は文字列 | 必須 | ゲストメンバーを更新するゲストスペースのIDを指定します。 |
| guests | 配列 | 必須 | 所属するゲストメンバーのログイン名(メールアドレス)を配列で指定します。 ※kintoneのゲストユーザではないユーザー、使用停止中のユーザー、削除したユーザーを指定するとエラーになります。 |
リクエストの例
HTTPリクエストのリクエストボディに JSON データをセットする例は以下の通りです。
リクエストヘッダ
PUT /k/guest/{guestspaceId}/v1/space/guests.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
ボディ
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
- JSON文字列をリクエストボディに載せて送ります。
レスポンス
処理成功時は空の JSON データが返されます。
JavaScriptサンプル
kintone REST APIリクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。