Manage2 API Functions - Edit Group

Description

This function edits the name and/or taxable status of an existing Manage2 group.

Examples

Browser-based Calls

XML

https://manage2.cpanel.net/XMLgroupEdit.cgi?group=ExampleGroup&newgroup=NewGroupName&taxable=0

JSON

https://manage2.cpanel.net/XMLgroupEdit.cgi?output=json&group=ExampleGroup&newgroup=NewGroupName&taxable=0

YAML

https://manage2.cpanel.net/XMLgroupEdit.cgi?output=yaml&group=ExampleGroup&newgroup=NewGroupName&taxable=0

cPanel Licensing PHP Class

<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("user@example.com","12345luggage");
$response = (array)$cpl->editGroup( array(
    'group'    => 'ExampleGroup',
    'newgroup' => 'NewGroupName',
    'taxable'  => '1'
));
?>

cPanel Licensing Perl Module

use cPanelLicensing;
my $cpl = cPanelLicensing->new(user => "user@example.com", pass => "12345luggage");
my $response = $licenseManager->editGroup(
    'group'    => 'ExampleGroup',
    'newgroup' => 'NewGroupName',
    'taxable'  => '1'
);

Output (JSON)

{  
   "status":1,
   "reason":"Updated 'NewGroupName' group."
}

Output (XML)

<XMLgroupEdit reason="Updated 'NewGroupName' group." status="1" />

Output (YAML)

--- 
reason: Updated 'NewGroupName' group.
status: 1

Parameters

Parameter	Type	Description	Possible values	Example
`group`	string	Required The group's current name. Note: You must provide either the `group` or `groupid` parameter.	A valid group.	`ExampleGroup`
`groupid`	string	Required The group's ID. Note: You must provide either the `group` or `groupid` parameter.	A valid group ID.	`G001`
`newgroup`	string	The new desired group name. Notes: The `newgroup` string cannot exceed 50 characters. You must enter a group name that does not already exist.	A valid string.	`NewGroupName`
`taxable`	Boolean	Whether the group's licenses are eligible for Texas state sales tax.	`1` — Taxable. `0` — Not taxable.	`1`

Returns

Return	Type	Description	Possible values	Example
`reason`	string	A message of success or failure.	A string value.	Updated 'NewGroupName' group.
`status`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`

Function information

API Version:

Manage2 API

Methods:

GET, POST

Required Parameters:

group or groupid

Return Formats:

JSON, XML, YAML

About the Manage2 API

The Manage2 API automates license management procedures.

Find a function

Related functions

Page:

Manage2 API Functions - List Package Information — This function returns the Manage2 account's packages.
Page:

Manage2 API Functions - Look Up License ID — This function returns an IP address's license ID.
Page:

Manage2 API Functions - Raw Lookup — This function returns an IP address's license information.
Page:

Manage2 API Functions - Add Licenses — This function adds a new license to a Manage2 account.
Page:

Manage2 API Functions - Change a License IP Address — This function transfers an existing license.

Child pages