templategroup.massremove

Description

object templategroup.massremove(object parameters)

This method allows to remove related objects from multiple 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) Parameters containing the IDs of the template groups to update and the objects that should be removed.

Parameter	Type	Description
groupids	string/array	IDs of the template groups to be updated. Parameter behavior: - required
templateids	string/array	Templates to remove from all template groups. Parameter behavior: - required

Return values

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

Examples

Removing templates from template groups

Remove two templates from the given template groups.

Request:

{
           "jsonrpc": "2.0",
           "method": "templategroup.massremove",
           "params": {
               "groupids": [
                   "5",
                   "6"
               ],
               "templateids": [
                   "30050",
                   "30001"
               ]
           },
           "id": 1
       }

Response:

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

Source

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

Documentation