Cancel a fax

POST 
/faxes/:id/actions/cancel

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

Request

Path Parameters

id uuidrequired

The unique identifier of a fax.

Responses

202: Successful response upon accepting cancel fax command

application/json

• Schema
• Example (from schema)

Schema

result string

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

404: Fax does not exist

422: Unprocessable entity

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L -X POST 'https://api.telnyx.com/v2/faxes/:id/actions/cancel' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 202
• default

---

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

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}