Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Identifies the resource.

Example:

"1293384261075731499"

Body

application/json

Parameters to be updated for the Fax Application

application_name
string
required

A user-assigned name to help manage the application.

Example:

"call-router"

webhook_event_url
string<uri>
required

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

active
boolean
default:true

Specifies whether the connection can be used.

Example:

false

anchorsite_override
enum<string>
default:Latency

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Available options:
Latency,
Chicago, IL,
Ashburn, VA,
San Jose, CA,
Sydney, Australia,
Amsterdam, Netherlands,
London, UK,
Toronto, Canada,
Vancouver, Canada,
Frankfurt, Germany
Example:

"Amsterdam, Netherlands"

webhook_event_failover_url
string<uri> | null
default:""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

webhook_timeout_secs
integer | null

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30
Example:

25

fax_email_recipient
string | null

Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments)

Example:

"user@example.com"

tags
string[]

Tags associated with the Fax Application.

Example:
inbound
object
outbound
object

Response

Successful response

data
Fax Application · object
Example: