Skip to content

Developer Function: Script: $p.apiGroupsDelete

Overview

This is a script function that allows you to delete a group using an Ajax POST request.

Syntax

JavaScript
$p.apiGroupsDelete ({
    id: <Group ID to be deleted>,
    done: <Optional Processing>,
    fail: <Optional Processing>,
    always: <Optional Processing>
});

Description Of Each Parameter

Parameter name Description Required
id Group ID to be deleted
done API communication successful
fail API communication failure -
always On completion -

Usage Example

JavaScript
$p.apiGroupsDelete({
    id: 123,
    done: function (data) {
        console.log(data);
        console.log('Group information was deleted successfully.');
    },
    fail: function () {
        console.log('Failed to delete group information.');
    },
    always: function () {
        console.log('Group information has been deleted.');
    }
});