掲示の内容を変更する

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

掲示の内容を変更する（2026年5月10日の定期メンテナンス後より適用されます）

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

掲示の内容を変更します。

URL

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

https://sample.cybozu.com/g/api/v1/bulletin/topics/TOPIC_ID

パスパラメーター

パラメーター名	説明
TOPIC_ID	変更する掲示のID

HTTPメソッド

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

PATCH

利用できるバージョン

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

クラウド版Garoon

リクエスト

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

パラメーター

すべてのプロパティは省略可です。指定されたプロパティのみが更新されます。指定されていないプロパティは変更されません。

パラメーター名	型	必須	説明
subject	文字列	省略可	掲示のタイトル
manuallySender	文字列	省略可	手動で入力する差出人名「差出人名を手動で入力する」設定がOFFの場合にこのパラメーターを指定すると、エラーが発生します。 `manuallySender`と`creatorGroupId`の両方を指定するとエラーが発生します。
creatorGroupId	数値または文字列	省略可	作成者が所属する組織のID
allowComments	真偽値	省略可	コメントの書き込みを許可するかどうか `true`：コメントの書き込みを許可する `false`：コメントの書き込みを許可しない
body	文字列	省略可	掲示の本文このプロパティを指定する場合は`isHtmlBody`が必須です。
isHtmlBody	真偽値	省略可	本文を書式編集（HTML形式）で保存するかどうか `true`：HTML形式 `false`：プレーンテキストこのプロパティを指定する場合は`body`が必須です。「書式編集を許可する」設定がOFFの場合に`true`を指定すると、エラーが発生します。
mentions	配列	省略可	掲示内でメンションするユーザー、組織（グループ）、または静的ロールのリスト掲示のカテゴリーを閲覧できないユーザーを含む`mentions`では掲示を変更できません。編集中の掲示にメンションが含まれていない場合、`mentions`を空の配列またはnull値で指定すると、メンションなしで掲示が変更されます。 `mentions`が空のオブジェクトを含む配列の場合、または`mentions[].id`または`mentions[].type`が欠けている場合、エラーが発生します。
mentions[].id	数値または文字列	必須（mentions指定時）	メンションするユーザー/組織（グループ）/静的ロールのID
mentions[].type	文字列	必須（mentions指定時）	メンションのタイプ `USER`、`GROUP`、`STATIC_ROLE`のいずれか
operatorType	文字列	省略可	掲示の変更/削除が可能なユーザーのタイプ `ONLY_SENDER`：差出人のみ `SELECT_USERS`：指定したユーザー編集中の掲示の「変更/削除可能なユーザー」が`ONLY_SENDER`の場合、`operators`のみを指定すると、「差出人のみ」のまま変更され、指定した`operators`は無視されます。編集中の掲示の「変更/削除可能なユーザー」が`ONLY_SENDER`の場合、`operatorType`を`SELECT_USERS`に指定して`operators`を指定しないと、「差出人のみ」のまま変更されます。編集中の掲示の「変更/削除可能なユーザー」が`SELECT_USERS`の場合、`operators`のみを指定すると、`operators`が更新されます。
operators	配列	省略可	掲示の変更/削除が可能なユーザーのリスト
operators[].id	数値または文字列	省略可	操作権限をもつユーザーのGaroonユーザーID `operators`を指定する場合、`operators[].id`または`operators[].code`のいずれかが必須です。
operators[].code	文字列	省略可	操作権限をもつユーザーのログイン名 `operators`を指定する場合、`operators[].id`または`operators[].code`のいずれかが必須です。 `operators[].id`と`operators[].code`の両方を指定した場合、`operators[].id`の値が使用されます。
attachments	配列	省略可	掲示の添付ファイルのリスト編集中の掲示に添付ファイルがある場合、`attachments[].name`と`attachments[].content`を指定してAPIを実行すると、既存の添付ファイルは削除され、指定した添付ファイルが追加されます。
attachments[].name	文字列	必須（attachments指定時）	ファイル名
attachments[].content	文字列	必須（attachments指定時）	ファイルの内容（Base64エンコードが必要）
publicPeriod	オブジェクト	省略可	掲示期間の情報空のオブジェクトを指定すると、掲示期間の情報は変更されません。
publicPeriod.isUnlimited	真偽値	省略可	掲示期間を無制限にするかどうか `true`：掲示期間を無制限にする `false`：掲示期間を指定する `false`を指定した場合でも、`publicPeriod.start`と`publicPeriod.end`を指定しないと、掲示期間は変更されません。
publicPeriod.start	文字列	省略可	掲示開始日時（ISO 8601形式） `isUnlimited`が`false`の場合、必須ではありません。公開中または期限切れの掲示の場合、`isUnlimited`が`false`で、このプロパティを現在の終了日時より前の将来の日時に指定すると、無視されます。現在の終了日時または現在の日時より後の将来の日時に指定すると、エラーが発生します。
publicPeriod.end	文字列	省略可	掲示終了日時（ISO 8601形式） `isUnlimited`が`false`の場合、必須ではありません。
isNotified	真偽値	省略可	掲示変更後に通知を送信するかどうか `true`：通知を送信する `false`：通知を送信しない省略時は`true`（通知が送信される）。掲示開始待ちの掲示の場合、指定しても無視されます。

リクエストの例

URL

https://sample.cybozu.com/g/api/v1/bulletin/topics/1

ヘッダー

1
2
3
4


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

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

ボディ

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34


{
  "subject": "Development plan Q2-2026",
  "publicPeriod": {
    "isUnlimited": false,
    "start": "2026-03-10T08:00:00Z",
    "end": "2026-03-20T08:00:00Z"
  },
  "creatorGroupId": "1",
  "body": "<div><strong>Plan</strong></div>",
  "isHtmlBody": true,
  "allowComments": true,
  "operatorType": "SELECT_USERS",
  "operators": [
    {
      "id": 3
    },
    {
      "code": "suzuki"
    }
  ],
  "isNotified": true,
  "attachments": [
    {
      "name": "plan.txt",
      "content": "TW9iaWxlIEZpdG5lc3MgQXBwIERldmVsb3BtZW50IFBsYW4="
    }
  ],
  "mentions": [
    {
      "id": 4,
      "type": "USER"
    }
  ]
}

レスポンス

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

プロパティ

プロパティ名	型	説明
id	文字列	掲示のID
subject	文字列	掲示のタイトル
creator	オブジェクト	掲示の作成者情報
creator.id	文字列	作成者のGaroonユーザーID
creator.name	文字列	作成者の表示名
creator.code	文字列	作成者のログイン名
updater	オブジェクト	掲示の更新者情報
updater.id	文字列	更新者のGaroonユーザーID
updater.name	文字列	更新者の表示名
updater.code	文字列	更新者のログイン名
manuallySender	文字列	直接入力された差出人名
createdAt	文字列	作成日時
updatedAt	文字列	更新日時
acknowledgement	真偽値	閲覧状況を確認するかどうか `true`：閲覧状況を確認する `false`：閲覧状況を確認しない
allowComments	真偽値	コメントの書き込みを許可するかどうか `true`：コメントの書き込みを許可する `false`：コメントの書き込みを許可しない
body	文字列	掲示の本文
isHtmlBody	真偽値	掲示の本文がHTML形式かどうか `true`： HTML形式 `false`：プレーンテキスト
operatorType	文字列	掲示の変更/削除の許可 `ONLY_SENDER`：差出人のみ `SELECT_USERS`：許可したユーザー
operators	配列	掲示の変更/削除が可能なユーザーの一覧
operators[].id	文字列	掲示の変更/削除を許可されているGaroonユーザーID
operators[].name	文字列	掲示の変更/削除を許可されているユーザーの表示名
operators[].code	文字列	掲示の変更/削除を許可されているユーザーのログイン名
attachments	配列	添付ファイルの一覧
attachments[].id	文字列	添付ファイルのID
attachments[].name	文字列	添付ファイルの名前
attachments[].contentType	文字列	添付ファイルのコンテンツタイプ
attachments[].size	文字列	添付ファイルのサイズ
publicPeriod	オブジェクト	掲示期間の情報
publicPeriod.isUnlimited	真偽値	掲示期間が指定されているかどうか `true`：掲示期間が指定されていない `false`：掲示期間が指定されている
publicPeriod.start	文字列	掲示開始日時
publicPeriod.end	文字列	掲示終了日時
isDraft	真偽値	下書きかどうか `true`：下書き `false`：下書きではない
isPublished	真偽値	掲示開始済みかどうか `true`：掲示開始済み `false`：掲示開始済みではない
isExpired	真偽値	掲示期間切れかどうか `true`：掲示期間切れ `false`：掲示期間切れではない
category	オブジェクト	掲示が属するカテゴリー情報
category.id	文字列	カテゴリーID
category.name	文字列	カテゴリー名

レスポンスの例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58


{
  "id": "1",
  "subject": "Development plan Q2-2026",
  "category": {
    "id": "2",
    "name": "Garoon"
  },
  "publicPeriod": {
    "isUnlimited": false,
    "start": "2026-03-10T08:00:00Z",
    "end": "2026-03-20T08:00:00Z"
  },
  "createdAt": "2026-03-09T03:24:39Z",
  "creator": {
    "id": "1",
    "code": "tanaka",
    "name": "Tanaka"
  },
  "updatedAt": "2026-03-10T04:24:39Z",
  "updater": {
    "id": "1",
    "code": "tanaka",
    "name": "Tanaka"
  },
  "body": "<div><strong>Plan</strong></div>",
  "isHtmlBody": true,
  "allowComments": true,
  "operatorType": "SELECT_USERS",
  "operators": [
    {
      "id": "2",
      "code": "yamamoto",
      "name": "Yamamoto"
    },
    {
      "id": "3",
      "code": "watanabe",
      "name": "Watanabe"
    },
    {
      "id": "5",
      "code": "suzuki",
      "name": "Suzuki"
    }
  ],
  "acknowledgement": false,
  "attachments": [
    {
      "id": "1",
      "contentType": "text/plain",
      "name": "plan.txt",
      "size": "140"
    }
  ],
  "isDraft": false,
  "isPublished": false,
  "isExpired": false
}

サンプルコード

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

curlを使ったリクエスト

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

1
2
3
4
5
6
7
8


curl -X PATCH 'https://sample.cybozu.com/g/api/v1/bulletin/topics/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "subject": "Development plan Q2-2026",
    "body": "<div>Updated plan</div>",
    "isHtmlBody": true
  }'

Garoon REST APIリクエストを送信するAPI を使ったリクエスト

1
2
3
4
5


await garoon.api('/api/v1/bulletin/topics/1', 'PATCH', {
  subject: 'Development plan Q2-2026',
  body: '<div>Updated plan</div>',
  isHtmlBody: true
});

Garoon API

Garoon APIドキュメント

掲示の内容を変更する

目次

掲示の内容を変更する（2026年5月10日の定期メンテナンス後より適用されます）

URL

パスパラメーター

HTTPメソッド

利用できるバージョン

リクエスト

パラメーター

リクエストの例

URL

ヘッダー

ボディ

レスポンス

プロパティ

レスポンスの例

サンプルコード

curlを使ったリクエスト

Garoon REST APIリクエストを送信するAPI を使ったリクエスト