templategroup.update

Description

object templategroup.update(object/array templateGroups)

This method allows to update existing template groups.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Template group properties to be updated.

The groupid property must be defined for each template group, all other properties are optional. Only the given properties will be updated, all others will remain unchanged.

Return values

(object) Returns an object containing the IDs of the updated template groups under the groupids property.

Példák

Renaming a template group

Rename a template group to "Templates/Databases"

Request:

{
           "jsonrpc": "2.0",
           "method": "templategroup.update",
           "params": {
               "groupid": "7",
               "name": "Templates/Databases"
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "groupids": [
                   "7"
               ]
           },
           "id": 1
       }

Source

CTemplateGroup::update() in ui/include/classes/api/services/CTemplateGroup.php.

Documentation