Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Programmable Fax Applications API

Fax Applications operations

Telnyx Programmable Fax Applications API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Programmable Fax Applications. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

5 operations 2 paths 16 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Programmable Fax Applications API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Programmable Fax Applications 5

Fax Applications operations

GET
/fax_applications
List all Fax Applications
ListFaxApplications 3 params → 200400401403
POST
/fax_applications
Creates a Fax Application
CreateFaxApplication body → 201401403422
DELETE
/fax_applications/{id}
Deletes a Fax Application
DeleteFaxApplication 1 param → 200400401403404
GET
/fax_applications/{id}
Retrieve a Fax Application
GetFaxApplication 1 param → 200400401403404
PATCH
/fax_applications/{id}
Update a Fax Application
UpdateFaxApplication 1 param body → 200401403404422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are FaxApplication (13 properties), UpdateFaxApplicationRequest (10 properties), CreateFaxApplicationRequest (9 properties), programmable-fax_Error (5 properties). Each schema is shown below with its type and property counts.

FaxEmailRecipient
stringnull
Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments)
ApplicationName
string
A user-assigned name to help manage the application.
OutboundVoiceProfileId
string
Identifies the associated outbound voice profile.
CreateFaxApplicationRequest
object
9 properties 2 required
ConnectionActive
boolean
Specifies whether the connection can be used.
ErrorResponse
object
1 property
WebhookEventUrl
string
The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
FaxApplication
object
13 properties
programmable-fax_Error
object
5 properties 2 required
AnchorsiteOverride
string
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 me…
UpdateFaxApplicationRequest
object
10 properties 2 required
WebhookEventFailoverUrl
stringnull
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'.
IntId
string
Uniquely identifies the resource.
PaginationMeta
object
4 properties
WebhookTimeoutSecs
integernull
Specifies how many seconds to wait before timing out a webhook.
programmable-fax_Errors
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-programmable-fax-applications-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API