ゲストスペースのゲストメンバー更新

ゲストスペースのメンバーの更新

ゲストスペースのゲストメンバーを指定した内容で上書きして更新します。

• スペース機能を利用していない場合にはエラーになります。
• ゲストスペース機能を利用していない場合にはエラーになります。
• メンバー更新の前にゲストユーザーの一括追加 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

XMLHttpRequest