Cancel a fax

Stops a sent fax that hasn't finished: one whose fax_status is queued, media.processed or sending.

Who may call it: an API key with All permissions, for every fax server of your account.

Effect: fax_status becomes cancelled, with fax_result_code 98 and fax_result_text Cancelled by user.

Response: 200 Fax cancelled successfully.

Notes:

  • Only faxes of your account are found: any other id answers 404 Fax not found.
  • A fax waiting for an automatic retry (failed, Retry Sending) can't be cancelled.

Logged: the cancellation is added to the fax's access history (access_type c).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The fax's fax_log_uuid.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json