Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Usage Batches

Executes the Cancel action for the Usage Batches data object.

Cancel Usage Batch

post/direct/subscribers/{subscriber_code}/vista/em/2/data/usage_batches/actions/cancel

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

Cointeger required
Mthstring date required

Format YYYY-MM-01.

BatchIdinteger required

If the batch is locked by someone else or can not otherwise be canceled, this action will return an error.

__clearBatchboolean

Optional. If omitted defaults to false. If omitted or falce this action will return a failure if there are entries in this batch.

Response

Success

idstring
operationstring
statusstring