Sign in
Faxes

Update a Fax

Cancels a fax while it is still in queued status. Faxes that have begun processing, sending, or receiving cannot be canceled with this operation. Fax Logs are read-only and cannot change delivery state.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Fax.

Learn more about API scopes.

post/Accounts/{AccountSid}/Faxes/{Sid}

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Account.

Sidstring uuid required

Universal Unique Identifier.

The Fax ID that uniquely identifies the Fax.

Response

The request has succeeded.

account_sidstring required

The unique identifier for the account this fax is associated with.

api_versionstring required

The version of the SignalWire API.

date_createdstring required

The date and time, in ISO 8601 format, the fax was created.

date_updatedstring required

The date and time, in ISO 8601 format, the fax was updated.

direction'inbound' | 'outbound' required

Fax direction.

fromstring required

The phone number, in E.164 format, the fax was sent from.

media_urlstring nullable required

The URL hosting the received media, or null if not available.

media_sidstring required

The unique identifier for the media instance associated with the fax instance.

num_pagesstring nullable required

The number of pages in the fax document, or null if not yet determined.

pricestring nullable required

The cost of the fax, or null if not yet calculated.

price_unitstring required

The currency, in ISO 4217 format, of the price.

quality'standard' | 'fine' | 'superfine' required

Fax quality.

sidstring required

The unique identifier of the fax.

status'queued' | 'processing' | 'sending' | 'delivered' | 'receiving' | 'received' | 'no-answer' | 'busy' | 'failed' | 'canceled' required

Fax status.

tostring required

The phone number, in E.164 format, the fax was sent to.

durationinteger required

The time, in seconds, it took to deliver a fax.

urlstring required

The URL of this resource.

error_codestring nullable required

Error code for this resource, or null if no error.

error_messagestring nullable required

The description of this error, or null if no error.

Example response

{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
  "api_version": "v1",
  "date_created": "2018-11-26T20:00:00Z",
  "date_updated": "2018-11-27T20:00:00Z",
  "from": "+13103383454",
  "media_url": "https://example.com/fax.pdf",
  "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
  "num_pages": "3",
  "price": "-0.005",
  "price_unit": "USD",
  "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
  "to": "+13104456789",
  "duration": 5000,
  "links": {
    "media": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
  },
  "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx"
}

Changes

Changed in 6 of the 40 revisions of this API.31153

  • 5344c0c93a4c16See the full diff
    • ▲

      added 'unevaluatedProperties' constraint to the request body

      request-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 200

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 400

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 401

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 404

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the response body for the status 422

      response-body-unevaluated-properties-added

    • ○

      added 'unevaluatedProperties' constraint to the links/allOf[FaxLinks]/ response property for the status 200

      response-property-unevaluated-properties-added

  • 2e516ba2383f5See the full diff
    • ▲

      response property error_code list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property error_message list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property media_url list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property num_pages list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property price list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

  • d5fbaaddfa3e1623See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ▲

      the request property Status became required

      request-property-became-required

    • ▲

      removed the enum value busy of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value delivered of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value failed of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value no-answer of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value processing of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value queued of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value received of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value receiving of the request property Status

      request-property-enum-value-removed

    • ▲

      removed the enum value sending of the request property Status

      request-property-enum-value-removed

    • ▲

      the response property error_code became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property error_message became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property media_url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property num_pages became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property price became nullable for the status 200

      response-property-became-nullable

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 422

      response-non-success-status-added

    • ○

      the response property account_sid became required for the status 200

      response-property-became-required

    • ○

      the response property api_version became required for the status 200

      response-property-became-required

    • ○

      the response property date_created became required for the status 200

      response-property-became-required

    • ○

      the response property date_updated became required for the status 200

      response-property-became-required

    • ○

      the response property direction became required for the status 200

      response-property-became-required

    • ○

      the response property duration became required for the status 200

      response-property-became-required

    • ○

      the response property error_code became required for the status 200

      response-property-became-required

    • ○

      the response property error_message became required for the status 200

      response-property-became-required

    • ○

      the response property from became required for the status 200

      response-property-became-required

    • ○

      the response property links became required for the status 200

      response-property-became-required

    • ○

      the response property links/allOf[FaxLinks]/media became required for the status 200

      response-property-became-required

    • ○

      the response property media_sid became required for the status 200

      response-property-became-required

    • ○

      the response property media_url became required for the status 200

      response-property-became-required

    • ○

      the response property num_pages became required for the status 200

      response-property-became-required

    • ○

      the response property price became required for the status 200

      response-property-became-required

    • ○

      the response property price_unit became required for the status 200

      response-property-became-required

    • ○

      the response property quality became required for the status 200

      response-property-became-required

    • ○

      the response property sid became required for the status 200

      response-property-became-required

    • ○

      the response property status became required for the status 200

      response-property-became-required

    • ○

      the response property to became required for the status 200

      response-property-became-required

    • ○

      the response property url became required for the status 200

      response-property-became-required

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a10b019314cd1See the full diff
    • ○

      request body became optional

      request-body-became-optional

  • 07f73f74a61d11See the full diff
    • ▲

      removed the media type application/json from the request body

      request-body-media-type-removed

    • ○

      added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3c88f14db21e8122See the full diff
    • ▲

      added the new path request parameter AccountSid

      new-request-path-parameter

    • ▲

      added the new path request parameter Sid

      new-request-path-parameter

    • ▲

      request body became required

      request-body-became-required

    • ▲

      removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

    • ▲

      the direction response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the links response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the quality response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property links/media from the response with the 200 status

      response-optional-property-removed

    • ○

      added the media type application/json to the request body

      request-body-media-type-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added FaxDirection to the direction response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added FaxLinks to the links response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added FaxQuality to the quality response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added FaxStatus to the status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed the busy enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the canceled enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the delivered enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the failed enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the fine enum value from the quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the inbound enum value from the direction response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the no-answer enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the outbound enum value from the direction response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the processing enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the queued enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the received enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the receiving enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the sending enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the standard enum value from the quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the superfine enum value from the quality response property for the response status 200

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog