開発者向け機能：スクリプト：$p.apiGroupsUpdate
## 概要
AjaxのPOSTリクエストにより、グループを更新します。
## 構文
##### JavaScript
```
$p.apiGroupsUpdate({
id: <対象のグループID>,
data: {
<更新するグループ情報>
},
done: <任意の処理>,
fail: <任意の処理>,
always: <任意の処理>
});
```
## 各パラメータの説明
| パラメータ名 | 型 | 必須 | 概要 |
| --- | --- | --- | --- |
| id | long | ○ | 対象のグループID |
| data | object | | 更新するグループ情報をJSON形式で指定 ※欄外補足参照 |
|done|function|○|API通信成功時に実行する処理|
|fail|function||API通信失敗時に実行する処理|
|always|function||API通信完了時に実行する処理|
※更新するグループ情報は、[APIグループ更新時](/manual/api-group-update)と同等のパラメータを設定します。リンク先のマニュアルを参照にパラメータを設定してください。
## 使用例
##### JavaScript
```
$p.apiGroupsUpdate({
id: 123,
data: {
GroupName: '更新後グループ名',
Body: '更新後グループ内容',
ClassHash: {
ClassA: 'test-class-column'
},
NumHash: {
NumA: 100
},
DateHash: {
DateA: '2026-08-19'
},
DescriptionHash: {
DescriptionA: '補足説明'
},
CheckHash: {
CheckA: true
},
GroupMembers: [
'User,1,True',
'Dept,1,False'
],
GroupChildren: [
'Group,1',
]
},
done: function (data) {
console.log(data);
console.log('グループ情報の更新に成功しました。');
},
fail: function () {
console.log('グループ情報の更新に失敗しました。');
},
always: function () {
console.log('グループ情報の更新が完了しました。');
}
});
```
## 戻り値
正常終了時は以下のようなオブジェクトが返却されます。
```json
{
"Id": 5,
"StatusCode": 200,
"Message": "\" [グループの名前] \" を更新しました。"
}
```
## 戻り値の項目
| 項目 | 説明 |
| ---------- | -------------------------- |
| Id | 更新されたグループのID |
| StatusCode | 実行結果のステータスコード |
| Message | 実行結果メッセージ |
## 対応バージョン
|対応バージョン|内容|
|:--|:--|
|1.5.8.0 以降|拡張項目をAPIで更新する機能を追加|
## 関連情報
[開発者向け機能：スクリプト：$p.apiGroupsGet](script-api-groups-get)
[開発者向け機能：スクリプト：$p.apiGroupsCreate](script-api-groups-create)
[開発者向け機能：スクリプト：$p.apiGroupsDelete](script-api-groups-delete)
[開発者向け機能：JSONデータレイアウト：Group](api-group)
