Vision 6

deleteBatch

Deletes the specified Batch.

deleteBatch

Deletes the specified Batch.

Top ↑

Syntax

bool deleteBatch( string api_key, int batch_id );

API Key Access Level required: Standard access

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

PHP

$api = new Api($url, 'YOURAPIKEY');

// setup vars
$batch_id = 1879999;

$result = $api->invokeMethod('deleteBatch', $batch_id);

JSON

{
    "id": 1,
    "method": "deleteBatch",
    "params": [
        "YOURAPIKEY",
        1879999
    ]
}

JSON Response

{
    "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.

See Also