Skip to main content

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

Schema

    result string

404: Fax does not exist

422: Unprocessable entity

default: Unexpected error

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
  • ]

Loading...