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

固定リンクがコピーされました

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

HTTPメソッド	PUT
URL	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/space/guests.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
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

{}

サンプルコード

kintone.api()を使ったリクエスト

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のフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
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

kintone API

kintone APIドキュメント

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

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足