kintone API

スペースのスレッドを作成する

スペースのスレッドを作成します。

目次

HTTPメソッドPOST
URLhttps://sample.cybozu.com/k/v1/space/thread.json
URL(ゲストスペース)https://sample.cybozu.com/k/guest/ゲストスペースID/v1/space/thread.json
認証 パスワード認証 , セッション認証 , OAuth認証
Content-Typeapplication/json

リクエストパラメーター

パラメーター名 必須 説明
space 数値または文字列 必須 スペースID
name 文字列 必須 スレッド名
1文字から128文字まで指定できます。

レスポンスプロパティ

プロパティ名 説明
id 文字列 作成されたスレッドのID

必要なアクセス権

  • スペースの閲覧権限
    非公開スペース/ゲストスペースの場合、スペース参加者のみ実行可能です。

サンプル

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

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

1
2
3
4
{
  "space": 1,
  "name": "サンプルスレッド"
}

1
2
3
{
  "id": "2"
}

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

1
2
3
4
5
const body = {
  space: 1,
  name: 'サンプルスレッド'
};
await kintone.api(kintone.api.url('/k/v1/space/thread.json', true), 'POST', body);

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6
7
curl -X POST 'https://sample.cybozu.com/k/v1/space/thread.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "space": 1,
    "name": "サンプルスレッド"
  }'

補足

  • スレッドを作成できるのは、スペースの設定で「スペースのポータルと複数のスレッドを使用する」が有効になっているスペースだけです。
  • スレッド作成の通知は、「すべて」の通知として、スペースの参加メンナーに通知されます。
  • スペース機能を利用していない場合には、エラーが発生します。
  • ゲストスペース機能が無効の場合に、ゲストスペースのスレッドを作成しようとするとエラーが発生します。