Developer Function: Script: $p.apiGroupsUpdate
## Overview
This is a script function that allows you to update groups using an Ajax POST request.
## Syntax
##### JavaScript
```
$p.apiGroupsUpdate({
id: <Target group ID>,
data: {
<Group information to be updated>
},
done: <Optional Processing>,
fail: <Optional Processing>,
always: <Optional Processing>
});
```
## Description Of Each Parameter
|Parameter name|Description|Required|
|:--|:--|:--:|
|id|Group ID to update|○|
|data|Group information to update *See additional information in the margin|○|
|done|API communication successful|○|
|fail|API communication failure|-|
|always|On completion|-|
*For the group information to be updated, set the same parameters as for [API group update](api-group-update). Please refer to the linked manual to set the parameters.
## Usage Example
##### JavaScript
```
$p.apiGroupsUpdate({
id: 123,
data: {
GroupName: 'Updated group name',
Body: 'Updated group contents',
GroupMembers: [
'User,1,True',
'Dept,1,False'
],
"GroupChildren": [
"Group,1,"
]
},
done: function (data) {
console.log(data);
console.log('Group information updated successfully.');
},
fail: function () {
console.log('Failed to update group information.');
},
always: function () {
console.log('Group information has been updated.');
}
});
```
