Syntax
bool deleteBatch( string api_key, int batch_id );
Parameters
api_key(string)The key required to access the API. See Getting Started for more information.
batch_id(int)The ID of the Batch to delete.
Return Value
Returns true on success.
Examples
$api = new Api($url, 'YOURAPIKEY');
// setup vars
$batch_id = 1879999;
$result = $api->invokeMethod('deleteBatch', $batch_id);
// setup vars
$batch_id = 1879999;
$result = $api->invokeMethod('deleteBatch', $batch_id);
{
"id": 1,
"method": "deleteBatch",
"params": [
"YOURAPIKEY",
1879999
]
}
"id": 1,
"method": "deleteBatch",
"params": [
"YOURAPIKEY",
1879999
]
}
{
"id": 1,
"result": true,
"error": null
}
"id": 1,
"result": true,
"error": null
}
Error Codes
This method may return the following error code in addition to the standard error codes:
| Code | Error | Description |
|---|---|---|
308 |
Unable to Load Batch | Make sure the Batch ID is correct. |