kintone APIドキュメント

スペースのスレッドを更新する

目次

スペースのスレッドを更新する

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

スペースまたはゲストスペースのスレッドを更新します。

  • スペース機能を利用していない場合には、エラーが発生します。
  • ゲストスペース機能が無効の場合に、ゲストスペースを更新しようとするとエラーが発生します。

URL

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

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

HTTPメソッド

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

PUT

必要なアクセス権

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

  • スペース管理者またはスレッド作成者

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
id 数値または文字列 必須 更新するスレッドのスレッドID
name 文字列 省略可 スレッド名
1文字から128文字まで指定できます。省略すると、スレッド名は更新されません。
シングルスレッドスペースのスレッドは、スレッド名が存在しないので更新できません。
body 文字列 省略可 スレッドの本文
65,535文字以下のHTML文字列を指定します。
省略すると、本文は更新されません。
許可されていないタグ、属性は保存時に削除されます。
アプリ貼り付け、ファイル添付、絵文字はHTMLで指定します。
宛先をHTML内で指定しても、その宛先には通知されません。
リクエストの例
ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

ボディ
1
2
3
4
5

{
  "id": "1",
  "name": "総務課連絡スレッド",
  "body": "<b>総務課</b>の連絡用スレッドです。"
}

レスポンス

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

1

{}

サンプル

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

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

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/space/thread.json' \
  -H 'X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "1",
    "name": "総務課連絡スレッド",
    "body": "<b>総務課</b>専用のスペースです。"
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する 

1
2
3
4
5
6
7

const body = {
  id: 1,
  name: '総務課連絡スレッド',
  body: '<b>総務課</b>の連絡用スレッドです。'
};

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