Developer Function: Script: $p.apiDeleteSite

2026-09-182026-09-18

Overview¶

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

Syntax¶

JavaScript¶

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

Description Of Each Parameter¶

Parameter name	Description	Required
id	Site ID to be deleted	Yes
done	API communication successful	Yes
fail	API communication failure	No
always	On completion	No

Usage Example¶

JavaScript¶

$p.apiDeleteSite({
    id: 123,
    done: function (data) {
        console.log(data);
        console.log('The site information was successfully deleted.');
    },
    fail: function () {
        console.log('Failed to delete site information.');
    },
    always: function () {
        console.log('Site information has been deleted.');
    }
});