Sign in
Programmable Fax Applications

Update a Fax Application

Updates settings of an existing Fax Application based on the parameters of the request.

patch/fax_applications/{id}

Path parameters

idstring required
Example:1293384261075731499

Identifies the resource.

Request body

activeboolean

Specifies whether the connection can be used.

anchorsite_override'Latency' | 'Chicago, IL' | 'Ashburn, VA' | 'San Jose, CA' | 'Sydney, Australia' | 'Amsterdam, Netherlands' | 'London, UK' | 'Toronto, Canada' | 'Vancouver, Canada' | 'Frankfurt, Germany'

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.

application_namestring required

A user-assigned name to help manage the application.

fax_email_recipientstring nullable

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

tagsstring[]

Tags associated with the Fax Application.

webhook_event_failover_urlstring uri nullable

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'.

webhook_event_urlstring uri required

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

webhook_timeout_secsinteger nullable

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

Example request

{
  "active": false,
  "anchorsite_override": "Amsterdam, Netherlands",
  "application_name": "fax-router",
  "inbound": {
    "channel_limit": 10,
    "sip_subdomain": "example",
    "sip_subdomain_receive_settings": "only_my_connections"
  },
  "outbound": {
    "channel_limit": 10,
    "outbound_voice_profile_id": "1293384261075731499"
  },
  "tags": [
    "tag1",
    "tag2"
  ],
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_event_url": "https://example.com",
  "webhook_timeout_secs": 25
}

Response

Successful response

Example response

{
  "data": {
    "active": false,
    "anchorsite_override": "Amsterdam, Netherlands",
    "application_name": "fax-router",
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "1293384261075731499",
    "inbound": {
      "channel_limit": 10,
      "sip_subdomain": "example",
      "sip_subdomain_receive_settings": "only_my_connections"
    },
    "outbound": {
      "channel_limit": 10,
      "outbound_voice_profile_id": "1293384261075731499"
    },
    "record_type": "fax_application",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_event_url": "https://example.com",
    "webhook_timeout_secs": 25
  }
}

Changes

Changed in 2 of the 61 revisions of this API.41

  • 1571b0380bd721See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

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

  • 8f5f4e5379942See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

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