kintone API ドキュメント

スペースの本文を更新する

目次

スペースの本文を更新する

スペースの本文を更新します。

  • スペース機能を利用していない場合には、エラーが発生します。
  • ゲストスペース機能が無効の場合に、ゲストスペースを更新しようとするとエラーが発生します。
  • この API では、マルチスレッドスペースの本文のみ更新できます。
    シングルスレッドスペースの本文を更新するときは、 スペースのスレッド更新 API を使用してください。

URL

通常のスペース
https://sample.cybozu.com/k/v1/space/body.json
ゲストスペース
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/space/body.json

HTTP メソッド

PUT

必要なアクセス権

  • スペース管理者

リクエスト

パラメーター
パラメーター名 型 必須 説明
id 数値または文字列 必須 本文を更新するスペースのスペース ID
body 文字列 必須 スペースの本文
HTML 文字列で記述します。許可されていないタグ、属性は保存時に削除されます。
アプリ貼り付け、ファイル添付、絵文字は HTML で指定します。
宛先を HTML 内で指定しても、その宛先には通知されません。
リクエストの例
ヘッダー
1
2
3
4

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

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

ボディ
1
2
3
4

{
  "id": 1,
  "body": "<b>総務課</b>専用のスペースです。"
}

レスポンス

1

{}

サンプルコード

curl を使ったリクエスト
1
2
3
4
5
6
7

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/space/body.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
      "id": 1,
      "body": "<b>総務課</b>専用のスペースです。"
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
6

const body = {
  id: 1,
  body: '<b>総務課</b>専用のスペースです。'
};

await kintone.api(kintone.api.url('/k/v1/space/body.json', true), 'PUT', body);