deleteAccount

Deletes the specified Account.

deleteAccount

Deletes the specified Account.

Top ↑

Syntax

bool deleteAccount( string api_key, int account_id );

Parameters

api_key (string)

The key required to access the API. See Getting Started for more information.

account_id (int)

The ID of the Account to delete.

Return Value

Returns true on success.

Examples

$api = new Api($url, $api_key);

$account_id = 12345;

$result = $api->invokeMethod('deleteAccount', $account_id);
{
    "id": 1,
    "method": "deleteAccount",
    "params": [
        "b7c6af6c1f9a298801b0fb96d52396a5b7c6af6c2581be559645b7ddd52396a5",
        12345
    ]
}
{
    "id": 1,
    "result": true,
    "error": null
}

Error Codes

This method may return the following error codes in addition to the standard error codes:

Code Error Description
302 Undefined Method Error Deactivation has failed. Please try again later.
310 Invalid Method Parameters One or more of the parameters you have passed are invalid.
321 Administrative access denied You do not have permission to delete the Account.

See Also