Create Fax Application Request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-create-fax-application-request-schema.json",
  "title": "Create Fax Application Request",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-programmable-fax-applications-api-openapi.yml#/components/schemas/CreateFaxApplicationRequest",
  "properties": {
    "active": {
      "$ref": "#/$defs/ConnectionActive"
    },
    "anchorsite_override": {
      "$ref": "#/$defs/AnchorsiteOverride"
    },
    "application_name": {
      "$ref": "#/$defs/ApplicationName"
    },
    "inbound": {
      "properties": {
        "channel_limit": {
          "default": null,
          "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.",
          "type": "integer"
        },
        "sip_subdomain": {
          "default": null,
          "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.",
          "type": "string"
        },
        "sip_subdomain_receive_settings": {
          "default": "from_anyone",
          "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).",
          "enum": [
            "only_my_connections",
            "from_anyone"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "outbound": {
      "properties": {
        "channel_limit": {
          "default": null,
          "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.",
          "type": "integer"
        },
        "outbound_voice_profile_id": {
          "$ref": "#/$defs/OutboundVoiceProfileId"
        }
      },
      "type": "object"
    },
    "tags": {
      "default": [],
      "description": "Tags associated with the Fax Application.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "webhook_event_failover_url": {
      "$ref": "#/$defs/WebhookEventFailoverUrl"
    },
    "webhook_event_url": {
      "$ref": "#/$defs/WebhookEventUrl"
    },
    "webhook_timeout_secs": {
      "$ref": "#/$defs/WebhookTimeoutSecs"
    }
  },
  "required": [
    "application_name",
    "webhook_event_url"
  ],
  "type": "object",
  "$defs": {
    "AnchorsiteOverride": {
      "default": "Latency",
      "description": "`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.",
      "enum": [
        "Latency",
        "Chicago, IL",
        "Ashburn, VA",
        "San Jose, CA",
        "Sydney, Australia",
        "Amsterdam, Netherlands",
        "London, UK",
        "Toronto, Canada",
        "Vancouver, Canada",
        "Frankfurt, Germany"
      ],
      "title": "Anchorsite Override",
      "type": "string"
    },
    "ApplicationName": {
      "description": "A user-assigned name to help manage the application.",
      "title": "Application Name",
      "type": "string"
    },
    "ConnectionActive": {
      "default": true,
      "description": "Specifies whether the connection can be used.",
      "title": "Connection Active",
      "type": "boolean"
    },
    "OutboundVoiceProfileId": {
      "description": "Identifies the associated outbound voice profile.",
      "title": "Outbound Voice Profile ID",
      "type": "string"
    },
    "WebhookEventFailoverUrl": {
      "default": "",
      "description": "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'.",
      "format": "uri",
      "title": "Webhook Event Failover URL",
      "type": [
        "string",
        "null"
      ]
    },
    "WebhookEventUrl": {
      "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.",
      "format": "uri",
      "title": "Webhook Event URL",
      "type": "string"
    },
    "WebhookTimeoutSecs": {
      "default": null,
      "description": "Specifies how many seconds to wait before timing out a webhook.",
      "maximum": 30,
      "minimum": 0,
      "title": "Webhook Timeout Secs",
      "type": [
        "integer",
        "null"
      ]
    }
  }
}