API Documentation > REST API > Rest API Reference > Sending Faxes > Sending Batches > Cancel Batch

Cancel batch

Cancel a batch in progress.

Note that this will have effect only on batch faxes that are awaiting sending (negative status values in the status codes list), but not on faxes that are actively being transmitted.

POST /outbound/batches/{id}/cancel

Arguments

Name (bold if mandatory Type Comments Default
id Number The batch ID to be cancelled. None, mandatory.

Response

Standard HTTP response codes apply.

Sample Call

Raw HTTP


POST /outbound/batches/280103726/cancel HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net

cURL


curl "https://rest.interfax.net/outbound/batches/280103726/cancel" ^
	-X POST ^
	-H content-length:0 ^
        -u username:password