Sidebar

manual:api:reference:trigger:delete

trigger.delete

Description

object trigger.delete(array triggerIds)

This method allows to delete triggers.

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 triggers to delete.

Return values

(object) Returns an object containing the IDs of the deleted triggers under the triggerids property.

Examples

Delete multiple triggers

Delete two triggers.

Request:

{
    "jsonrpc": "2.0",
    "method": "trigger.delete",
    "params": [
        "12002",
        "12003"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "triggerids": [
            "12002",
            "12003"
        ]
    },
    "id": 1
}

Source

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