templategroup.delete

Description

object templategroup.delete(array templateGroupIds)

This method allows to delete template groups.

A template group can not be deleted if it contains templates that belong to this group only.

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

(array) IDs of the template groups to delete.

Return values

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

Examples

Deleting multiple template groups

Delete two template groups.

Request:

{
           "jsonrpc": "2.0",
           "method": "templategroup.delete",
           "params": [
               "107814",
               "107815"
           ],
           "id": 1
       }

Response:

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

Source

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

Documentation