Programmable Fax Commands

Cancel a fax

Changed on

Cancel the outbound fax that is in one of the following states: queued, media.processed, originated or sending

post/faxes/{id}/actions/cancel

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/faxes/{id}/actions/cancel
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The unique identifier of a fax.

Response

Successful response upon accepting cancel fax command

Example response

{
  "data": {
    "result": "ok"
  }
}

Changes

  • 67df31283a8aRevision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a72569d69430Revision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status