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.

Exemplos

Deleting multiple template groups

Delete two template groups.

Request:

{
           "jsonrpc": "2.0",
           "method": "templategroup.delete",
           "params": [
               "107814",
               "107815"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }
Copy
✔ Copied

Response:

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

Source

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.